blob: e06f034c1570e2043d5d9ea87e142288d26418b8 [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;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010020import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070021import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070023import org.xmlpull.v1.XmlPullParser;
24import org.xmlpull.v1.XmlPullParserException;
25
Tor Norbyed9273d62013-05-30 15:59:53 -070026import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.annotation.SdkConstant.SdkConstantType;
30import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070031
Nicolas Prevotd85fc722014-04-16 19:52:08 +010032import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070033
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.content.pm.PackageManager;
35import android.content.pm.ResolveInfo;
36import android.content.res.Resources;
37import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080038import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.net.Uri;
40import android.os.Bundle;
41import android.os.IBinder;
42import android.os.Parcel;
43import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000044import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070045import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010046import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070047import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070048import android.provider.DocumentsProvider;
49import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070050import android.util.AttributeSet;
51import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080052
53import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070054
Craig Mautner21d24a22014-04-23 11:45:37 -070055import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070056
57import java.io.IOException;
58import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070059import java.lang.annotation.Retention;
60import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070061import java.net.URISyntaxException;
62import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
68/**
69 * An intent is an abstract description of an operation to be performed. It
70 * can be used with {@link Context#startActivity(Intent) startActivity} to
71 * launch an {@link android.app.Activity},
72 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
73 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
74 * and {@link android.content.Context#startService} or
75 * {@link android.content.Context#bindService} to communicate with a
76 * background {@link android.app.Service}.
77 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070078 * <p>An Intent provides a facility for performing late runtime binding between the code in
79 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070080 * can be thought of as the glue between activities. It is basically a passive data structure
81 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070082 *
83 * <div class="special reference">
84 * <h3>Developer Guides</h3>
85 * <p>For information about how to create and resolve intents, read the
86 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
87 * developer guide.</p>
88 * </div>
89 *
90 * <a name="IntentStructure"></a>
91 * <h3>Intent Structure</h3>
92 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 *
94 * <ul>
95 * <li> <p><b>action</b> -- The general action to be performed, such as
96 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
97 * etc.</p>
98 * </li>
99 * <li> <p><b>data</b> -- The data to operate on, such as a person record
100 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
101 * </li>
102 * </ul>
103 *
104 *
105 * <p>Some examples of action/data pairs are:</p>
106 *
107 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700108 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700109 * information about the person whose identifier is "1".</p>
110 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700111 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700112 * the phone dialer with the person filled in.</p>
113 * </li>
114 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
115 * the phone dialer with the given number filled in. Note how the
116 * VIEW action does what what is considered the most reasonable thing for
117 * a particular URI.</p>
118 * </li>
119 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
120 * the phone dialer with the given number filled in.</p>
121 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700122 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700123 * information about the person whose identifier is "1".</p>
124 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700125 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700126 * a list of people, which the user can browse through. This example is a
127 * typical top-level entry into the Contacts application, showing you the
128 * list of people. Selecting a particular person to view would result in a
129 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
130 * being used to start an activity to display that person.</p>
131 * </li>
132 * </ul>
133 *
134 * <p>In addition to these primary attributes, there are a number of secondary
135 * attributes that you can also include with an intent:</p>
136 *
137 * <ul>
138 * <li> <p><b>category</b> -- Gives additional information about the action
139 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
140 * appear in the Launcher as a top-level application, while
141 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
142 * of alternative actions the user can perform on a piece of data.</p>
143 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
144 * intent data. Normally the type is inferred from the data itself.
145 * By setting this attribute, you disable that evaluation and force
146 * an explicit type.</p>
147 * <li> <p><b>component</b> -- Specifies an explicit name of a component
148 * class to use for the intent. Normally this is determined by looking
149 * at the other information in the intent (the action, data/type, and
150 * categories) and matching that with a component that can handle it.
151 * If this attribute is set then none of the evaluation is performed,
152 * and this component is used exactly as is. By specifying this attribute,
153 * all of the other Intent attributes become optional.</p>
154 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
155 * This can be used to provide extended information to the component.
156 * For example, if we have a action to send an e-mail message, we could
157 * also include extra pieces of data here to supply a subject, body,
158 * etc.</p>
159 * </ul>
160 *
161 * <p>Here are some examples of other operations you can specify as intents
162 * using these additional parameters:</p>
163 *
164 * <ul>
165 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
166 * Launch the home screen.</p>
167 * </li>
168 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
169 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
170 * vnd.android.cursor.item/phone}</i></b>
171 * -- Display the list of people's phone numbers, allowing the user to
172 * browse through them and pick one and return it to the parent activity.</p>
173 * </li>
174 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
175 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
176 * -- Display all pickers for data that can be opened with
177 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
178 * allowing the user to pick one of them and then some data inside of it
179 * and returning the resulting URI to the caller. This can be used,
180 * for example, in an e-mail application to allow the user to pick some
181 * data to include as an attachment.</p>
182 * </li>
183 * </ul>
184 *
185 * <p>There are a variety of standard Intent action and category constants
186 * defined in the Intent class, but applications can also define their own.
187 * These strings use java style scoping, to ensure they are unique -- for
188 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700189 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 *
191 * <p>Put together, the set of actions, data types, categories, and extra data
192 * defines a language for the system allowing for the expression of phrases
193 * such as "call john smith's cell". As applications are added to the system,
194 * they can extend this language by adding new actions, types, and categories, or
195 * they can modify the behavior of existing phrases by supplying their own
196 * activities that handle them.</p>
197 *
198 * <a name="IntentResolution"></a>
199 * <h3>Intent Resolution</h3>
200 *
201 * <p>There are two primary forms of intents you will use.
202 *
203 * <ul>
204 * <li> <p><b>Explicit Intents</b> have specified a component (via
205 * {@link #setComponent} or {@link #setClass}), which provides the exact
206 * class to be run. Often these will not include any other information,
207 * simply being a way for an application to launch various internal
208 * activities it has as the user interacts with the application.
209 *
210 * <li> <p><b>Implicit Intents</b> have not specified a component;
211 * instead, they must include enough information for the system to
212 * determine which of the available components is best to run for that
213 * intent.
214 * </ul>
215 *
216 * <p>When using implicit intents, given such an arbitrary intent we need to
217 * know what to do with it. This is handled by the process of <em>Intent
218 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
219 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
220 * more activities/receivers) that can handle it.</p>
221 *
222 * <p>The intent resolution mechanism basically revolves around matching an
223 * Intent against all of the &lt;intent-filter&gt; descriptions in the
224 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
225 * objects explicitly registered with {@link Context#registerReceiver}.) More
226 * details on this can be found in the documentation on the {@link
227 * IntentFilter} class.</p>
228 *
229 * <p>There are three pieces of information in the Intent that are used for
230 * resolution: the action, type, and category. Using this information, a query
231 * is done on the {@link PackageManager} for a component that can handle the
232 * intent. The appropriate component is determined based on the intent
233 * information supplied in the <code>AndroidManifest.xml</code> file as
234 * follows:</p>
235 *
236 * <ul>
237 * <li> <p>The <b>action</b>, if given, must be listed by the component as
238 * one it handles.</p>
239 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
240 * already supplied in the Intent. Like the action, if a type is
241 * included in the intent (either explicitly or implicitly in its
242 * data), then this must be listed by the component as one it handles.</p>
243 * <li> For data that is not a <code>content:</code> URI and where no explicit
244 * type is included in the Intent, instead the <b>scheme</b> of the
245 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
246 * considered. Again like the action, if we are matching a scheme it
247 * must be listed by the component as one it can handle.
248 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
249 * by the activity as categories it handles. That is, if you include
250 * the categories {@link #CATEGORY_LAUNCHER} and
251 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
252 * with an intent that lists <em>both</em> of those categories.
253 * Activities will very often need to support the
254 * {@link #CATEGORY_DEFAULT} so that they can be found by
255 * {@link Context#startActivity Context.startActivity()}.</p>
256 * </ul>
257 *
258 * <p>For example, consider the Note Pad sample application that
259 * allows user to browse through a list of notes data and view details about
260 * individual items. Text in italics indicate places were you would replace a
261 * name with one specific to your own package.</p>
262 *
263 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
264 * package="<i>com.android.notepad</i>"&gt;
265 * &lt;application android:icon="@drawable/app_notes"
266 * android:label="@string/app_name"&gt;
267 *
268 * &lt;provider class=".NotePadProvider"
269 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
270 *
271 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
272 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.MAIN" /&gt;
274 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700275 * &lt;/intent-filter&gt;
276 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700277 * &lt;action android:name="android.intent.action.VIEW" /&gt;
278 * &lt;action android:name="android.intent.action.EDIT" /&gt;
279 * &lt;action android:name="android.intent.action.PICK" /&gt;
280 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
281 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700282 * &lt;/intent-filter&gt;
283 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700284 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
285 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
286 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700287 * &lt;/intent-filter&gt;
288 * &lt;/activity&gt;
289 *
290 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
291 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700292 * &lt;action android:name="android.intent.action.VIEW" /&gt;
293 * &lt;action android:name="android.intent.action.EDIT" /&gt;
294 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
295 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700296 * &lt;/intent-filter&gt;
297 *
298 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700299 * &lt;action android:name="android.intent.action.INSERT" /&gt;
300 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
301 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700302 * &lt;/intent-filter&gt;
303 *
304 * &lt;/activity&gt;
305 *
306 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
307 * android:theme="@android:style/Theme.Dialog"&gt;
308 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700309 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
310 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
311 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
312 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
313 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700314 * &lt;/intent-filter&gt;
315 * &lt;/activity&gt;
316 *
317 * &lt;/application&gt;
318 * &lt;/manifest&gt;</pre>
319 *
320 * <p>The first activity,
321 * <code>com.android.notepad.NotesList</code>, serves as our main
322 * entry into the app. It can do three things as described by its three intent
323 * templates:
324 * <ol>
325 * <li><pre>
326 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700327 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
328 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700329 * &lt;/intent-filter&gt;</pre>
330 * <p>This provides a top-level entry into the NotePad application: the standard
331 * MAIN action is a main entry point (not requiring any other information in
332 * the Intent), and the LAUNCHER category says that this entry point should be
333 * listed in the application launcher.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
337 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
338 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
339 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
340 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700341 * &lt;/intent-filter&gt;</pre>
342 * <p>This declares the things that the activity can do on a directory of
343 * notes. The type being supported is given with the &lt;type&gt; tag, where
344 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
345 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
346 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
347 * The activity allows the user to view or edit the directory of data (via
348 * the VIEW and EDIT actions), or to pick a particular note and return it
349 * to the caller (via the PICK action). Note also the DEFAULT category
350 * supplied here: this is <em>required</em> for the
351 * {@link Context#startActivity Context.startActivity} method to resolve your
352 * activity when its component name is not explicitly specified.</p>
353 * <li><pre>
354 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700355 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
356 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
357 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700358 * &lt;/intent-filter&gt;</pre>
359 * <p>This filter describes the ability return to the caller a note selected by
360 * the user without needing to know where it came from. The data type
361 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
362 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
363 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
364 * The GET_CONTENT action is similar to the PICK action, where the activity
365 * will return to its caller a piece of data selected by the user. Here,
366 * however, the caller specifies the type of data they desire instead of
367 * the type of data the user will be picking from.</p>
368 * </ol>
369 *
370 * <p>Given these capabilities, the following intents will resolve to the
371 * NotesList activity:</p>
372 *
373 * <ul>
374 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
375 * activities that can be used as top-level entry points into an
376 * application.</p>
377 * <li> <p><b>{ action=android.app.action.MAIN,
378 * category=android.app.category.LAUNCHER }</b> is the actual intent
379 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700380 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700381 * data=content://com.google.provider.NotePad/notes }</b>
382 * displays a list of all the notes under
383 * "content://com.google.provider.NotePad/notes", which
384 * the user can browse through and see the details on.</p>
385 * <li> <p><b>{ action=android.app.action.PICK
386 * data=content://com.google.provider.NotePad/notes }</b>
387 * provides a list of the notes under
388 * "content://com.google.provider.NotePad/notes", from which
389 * the user can pick a note whose data URL is returned back to the caller.</p>
390 * <li> <p><b>{ action=android.app.action.GET_CONTENT
391 * type=vnd.android.cursor.item/vnd.google.note }</b>
392 * is similar to the pick action, but allows the caller to specify the
393 * kind of data they want back so that the system can find the appropriate
394 * activity to pick something of that data type.</p>
395 * </ul>
396 *
397 * <p>The second activity,
398 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
399 * note entry and allows them to edit it. It can do two things as described
400 * by its two intent templates:
401 * <ol>
402 * <li><pre>
403 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700404 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
405 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
406 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
407 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700408 * &lt;/intent-filter&gt;</pre>
409 * <p>The first, primary, purpose of this activity is to let the user interact
410 * with a single note, as decribed by the MIME type
411 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
412 * either VIEW a note or allow the user to EDIT it. Again we support the
413 * DEFAULT category to allow the activity to be launched without explicitly
414 * specifying its component.</p>
415 * <li><pre>
416 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700417 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
418 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
419 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700420 * &lt;/intent-filter&gt;</pre>
421 * <p>The secondary use of this activity is to insert a new note entry into
422 * an existing directory of notes. This is used when the user creates a new
423 * note: the INSERT action is executed on the directory of notes, causing
424 * this activity to run and have the user create the new note data which
425 * it then adds to the content provider.</p>
426 * </ol>
427 *
428 * <p>Given these capabilities, the following intents will resolve to the
429 * NoteEditor activity:</p>
430 *
431 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700432 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700433 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
434 * shows the user the content of note <var>{ID}</var>.</p>
435 * <li> <p><b>{ action=android.app.action.EDIT
436 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
437 * allows the user to edit the content of note <var>{ID}</var>.</p>
438 * <li> <p><b>{ action=android.app.action.INSERT
439 * data=content://com.google.provider.NotePad/notes }</b>
440 * creates a new, empty note in the notes list at
441 * "content://com.google.provider.NotePad/notes"
442 * and allows the user to edit it. If they keep their changes, the URI
443 * of the newly created note is returned to the caller.</p>
444 * </ul>
445 *
446 * <p>The last activity,
447 * <code>com.android.notepad.TitleEditor</code>, allows the user to
448 * edit the title of a note. This could be implemented as a class that the
449 * application directly invokes (by explicitly setting its component in
450 * the Intent), but here we show a way you can publish alternative
451 * operations on existing data:</p>
452 *
453 * <pre>
454 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700455 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
456 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
457 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
459 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700460 * &lt;/intent-filter&gt;</pre>
461 *
462 * <p>In the single intent template here, we
463 * have created our own private action called
464 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
465 * edit the title of a note. It must be invoked on a specific note
466 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
467 * view and edit actions, but here displays and edits the title contained
468 * in the note data.
469 *
470 * <p>In addition to supporting the default category as usual, our title editor
471 * also supports two other standard categories: ALTERNATIVE and
472 * SELECTED_ALTERNATIVE. Implementing
473 * these categories allows others to find the special action it provides
474 * without directly knowing about it, through the
475 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
476 * more often to build dynamic menu items with
477 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
478 * template here was also supply an explicit name for the template
479 * (via <code>android:label="@string/resolve_title"</code>) to better control
480 * what the user sees when presented with this activity as an alternative
481 * action to the data they are viewing.
482 *
483 * <p>Given these capabilities, the following intent will resolve to the
484 * TitleEditor activity:</p>
485 *
486 * <ul>
487 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
488 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
489 * displays and allows the user to edit the title associated
490 * with note <var>{ID}</var>.</p>
491 * </ul>
492 *
493 * <h3>Standard Activity Actions</h3>
494 *
495 * <p>These are the current standard actions that Intent defines for launching
496 * activities (usually through {@link Context#startActivity}. The most
497 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
498 * {@link #ACTION_EDIT}.
499 *
500 * <ul>
501 * <li> {@link #ACTION_MAIN}
502 * <li> {@link #ACTION_VIEW}
503 * <li> {@link #ACTION_ATTACH_DATA}
504 * <li> {@link #ACTION_EDIT}
505 * <li> {@link #ACTION_PICK}
506 * <li> {@link #ACTION_CHOOSER}
507 * <li> {@link #ACTION_GET_CONTENT}
508 * <li> {@link #ACTION_DIAL}
509 * <li> {@link #ACTION_CALL}
510 * <li> {@link #ACTION_SEND}
511 * <li> {@link #ACTION_SENDTO}
512 * <li> {@link #ACTION_ANSWER}
513 * <li> {@link #ACTION_INSERT}
514 * <li> {@link #ACTION_DELETE}
515 * <li> {@link #ACTION_RUN}
516 * <li> {@link #ACTION_SYNC}
517 * <li> {@link #ACTION_PICK_ACTIVITY}
518 * <li> {@link #ACTION_SEARCH}
519 * <li> {@link #ACTION_WEB_SEARCH}
520 * <li> {@link #ACTION_FACTORY_TEST}
521 * </ul>
522 *
523 * <h3>Standard Broadcast Actions</h3>
524 *
525 * <p>These are the current standard actions that Intent defines for receiving
526 * broadcasts (usually through {@link Context#registerReceiver} or a
527 * &lt;receiver&gt; tag in a manifest).
528 *
529 * <ul>
530 * <li> {@link #ACTION_TIME_TICK}
531 * <li> {@link #ACTION_TIME_CHANGED}
532 * <li> {@link #ACTION_TIMEZONE_CHANGED}
533 * <li> {@link #ACTION_BOOT_COMPLETED}
534 * <li> {@link #ACTION_PACKAGE_ADDED}
535 * <li> {@link #ACTION_PACKAGE_CHANGED}
536 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800537 * <li> {@link #ACTION_PACKAGE_RESTARTED}
538 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700539 * <li> {@link #ACTION_UID_REMOVED}
540 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700541 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700542 * <li> {@link #ACTION_POWER_DISCONNECTED}
543 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700544 * </ul>
545 *
546 * <h3>Standard Categories</h3>
547 *
548 * <p>These are the current standard categories that can be used to further
549 * clarify an Intent via {@link #addCategory}.
550 *
551 * <ul>
552 * <li> {@link #CATEGORY_DEFAULT}
553 * <li> {@link #CATEGORY_BROWSABLE}
554 * <li> {@link #CATEGORY_TAB}
555 * <li> {@link #CATEGORY_ALTERNATIVE}
556 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
557 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800558 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700559 * <li> {@link #CATEGORY_HOME}
560 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700561 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400562 * <li> {@link #CATEGORY_CAR_DOCK}
563 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500564 * <li> {@link #CATEGORY_LE_DESK_DOCK}
565 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200566 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700567 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700568 * </ul>
569 *
570 * <h3>Standard Extra Data</h3>
571 *
572 * <p>These are the current standard fields that can be used as extra data via
573 * {@link #putExtra}.
574 *
575 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_ALARM_COUNT}
577 * <li> {@link #EXTRA_BCC}
578 * <li> {@link #EXTRA_CC}
579 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
580 * <li> {@link #EXTRA_DATA_REMOVED}
581 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500582 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
583 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_DOCK_STATE_CAR}
585 * <li> {@link #EXTRA_DOCK_STATE_DESK}
586 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
587 * <li> {@link #EXTRA_DONT_KILL_APP}
588 * <li> {@link #EXTRA_EMAIL}
589 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700590 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800591 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700592 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700594 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
596 * <li> {@link #EXTRA_REPLACING}
597 * <li> {@link #EXTRA_SHORTCUT_ICON}
598 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
599 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700600 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800601 * <li> {@link #EXTRA_SHORTCUT_NAME}
602 * <li> {@link #EXTRA_SUBJECT}
603 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_TITLE}
606 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700607 * </ul>
608 *
609 * <h3>Flags</h3>
610 *
611 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800612 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
613 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700614 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800615public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700616 private static final String ATTR_ACTION = "action";
617 private static final String TAG_CATEGORIES = "categories";
618 private static final String ATTR_CATEGORY = "category";
619 private static final String TAG_EXTRA = "extra";
620 private static final String ATTR_TYPE = "type";
621 private static final String ATTR_COMPONENT = "component";
622 private static final String ATTR_DATA = "data";
623 private static final String ATTR_FLAGS = "flags";
624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 // ---------------------------------------------------------------------
626 // ---------------------------------------------------------------------
627 // Standard intent activity actions (see action variable).
628
629 /**
630 * Activity Action: Start as a main entry point, does not expect to
631 * receive data.
632 * <p>Input: nothing
633 * <p>Output: nothing
634 */
635 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
636 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 /**
639 * Activity Action: Display the data to the user. This is the most common
640 * action performed on data -- it is the generic action you can use on
641 * a piece of data to get the most reasonable thing to occur. For example,
642 * when used on a contacts entry it will view the entry; when used on a
643 * mailto: URI it will bring up a compose window filled with the information
644 * supplied by the URI; when used with a tel: URI it will invoke the
645 * dialer.
646 * <p>Input: {@link #getData} is URI from which to retrieve data.
647 * <p>Output: nothing.
648 */
649 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
650 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800651
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700652 /**
653 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
654 * performed on a piece of data.
655 */
656 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Used to indicate that some piece of data should be attached to some other
660 * place. For example, image data could be attached to a contact. It is up
661 * to the recipient to decide where the data should be attached; the intent
662 * does not specify the ultimate destination.
663 * <p>Input: {@link #getData} is URI of data to be attached.
664 * <p>Output: nothing.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Provide explicit editable access to the given data.
671 * <p>Input: {@link #getData} is URI of data to be edited.
672 * <p>Output: nothing.
673 */
674 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
675 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 /**
678 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
679 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
680 * The extras can contain type specific data to pass through to the editing/creating
681 * activity.
682 * <p>Output: The URI of the item that was picked. This must be a content:
683 * URI so that any receiver can access it.
684 */
685 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
686 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800687
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700688 /**
689 * Activity Action: Pick an item from the data, returning what was selected.
690 * <p>Input: {@link #getData} is URI containing a directory of data
691 * (vnd.android.cursor.dir/*) from which to pick an item.
692 * <p>Output: The URI of the item that was picked.
693 */
694 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
695 public static final String ACTION_PICK = "android.intent.action.PICK";
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: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800699 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700700 * <p>Output: An Intent representing the shortcut. The intent must contain three
701 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
702 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800703 * (value: ShortcutIconResource).</p>
704 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700705 * @see #EXTRA_SHORTCUT_INTENT
706 * @see #EXTRA_SHORTCUT_NAME
707 * @see #EXTRA_SHORTCUT_ICON
708 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
709 * @see android.content.Intent.ShortcutIconResource
710 */
711 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
712 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
713
714 /**
715 * The name of the extra used to define the Intent of a shortcut.
716 *
717 * @see #ACTION_CREATE_SHORTCUT
718 */
719 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
720 /**
721 * The name of the extra used to define the name of a shortcut.
722 *
723 * @see #ACTION_CREATE_SHORTCUT
724 */
725 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
726 /**
727 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
728 *
729 * @see #ACTION_CREATE_SHORTCUT
730 */
731 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
732 /**
733 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
734 *
735 * @see #ACTION_CREATE_SHORTCUT
736 * @see android.content.Intent.ShortcutIconResource
737 */
738 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
739 "android.intent.extra.shortcut.ICON_RESOURCE";
740
741 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800742 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700743 *
744 * @see Intent#ACTION_CREATE_SHORTCUT
745 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800746 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
747 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 */
749 public static class ShortcutIconResource implements Parcelable {
750 /**
751 * The package name of the application containing the icon.
752 */
753 public String packageName;
754
755 /**
756 * The resource name of the icon, including package, name and type.
757 */
758 public String resourceName;
759
760 /**
761 * Creates a new ShortcutIconResource for the specified context and resource
762 * identifier.
763 *
764 * @param context The context of the application.
765 * @param resourceId The resource idenfitier for the icon.
766 * @return A new ShortcutIconResource with the specified's context package name
767 * and icon resource idenfitier.
768 */
769 public static ShortcutIconResource fromContext(Context context, int resourceId) {
770 ShortcutIconResource icon = new ShortcutIconResource();
771 icon.packageName = context.getPackageName();
772 icon.resourceName = context.getResources().getResourceName(resourceId);
773 return icon;
774 }
775
776 /**
777 * Used to read a ShortcutIconResource from a Parcel.
778 */
779 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
780 new Parcelable.Creator<ShortcutIconResource>() {
781
782 public ShortcutIconResource createFromParcel(Parcel source) {
783 ShortcutIconResource icon = new ShortcutIconResource();
784 icon.packageName = source.readString();
785 icon.resourceName = source.readString();
786 return icon;
787 }
788
789 public ShortcutIconResource[] newArray(int size) {
790 return new ShortcutIconResource[size];
791 }
792 };
793
794 /**
795 * No special parcel contents.
796 */
797 public int describeContents() {
798 return 0;
799 }
800
801 public void writeToParcel(Parcel dest, int flags) {
802 dest.writeString(packageName);
803 dest.writeString(resourceName);
804 }
805
806 @Override
807 public String toString() {
808 return resourceName;
809 }
810 }
811
812 /**
813 * Activity Action: Display an activity chooser, allowing the user to pick
814 * what they want to before proceeding. This can be used as an alternative
815 * to the standard activity picker that is displayed by the system when
816 * you try to start an activity with multiple possible matches, with these
817 * differences in behavior:
818 * <ul>
819 * <li>You can specify the title that will appear in the activity chooser.
820 * <li>The user does not have the option to make one of the matching
821 * activities a preferred activity, and all possible activities will
822 * always be shown even if one of them is currently marked as the
823 * preferred activity.
824 * </ul>
825 * <p>
826 * This action should be used when the user will naturally expect to
827 * select an activity in order to proceed. An example if when not to use
828 * it is when the user clicks on a "mailto:" link. They would naturally
829 * expect to go directly to their mail app, so startActivity() should be
830 * called directly: it will
831 * either launch the current preferred app, or put up a dialog allowing the
832 * user to pick an app to use and optionally marking that as preferred.
833 * <p>
834 * In contrast, if the user is selecting a menu item to send a picture
835 * they are viewing to someone else, there are many different things they
836 * may want to do at this point: send it through e-mail, upload it to a
837 * web service, etc. In this case the CHOOSER action should be used, to
838 * always present to the user a list of the things they can do, with a
839 * nice title given by the caller such as "Send this photo with:".
840 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700841 * If you need to grant URI permissions through a chooser, you must specify
842 * the permissions to be granted on the ACTION_CHOOSER Intent
843 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
844 * {@link #setClipData} to specify the URIs to be granted as well as
845 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
846 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
847 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700848 * As a convenience, an Intent of this form can be created with the
849 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700850 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700851 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700852 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
853 * and can optionally have a {@link #EXTRA_TITLE} field containing the
854 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700855 * <p>
856 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700857 */
858 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
859 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
860
861 /**
862 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
863 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700864 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
865 * target intent, also optionally supplying a title. If the target
866 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
867 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
868 * set in the returned chooser intent, with its ClipData set appropriately:
869 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500870 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700871 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700872 * @param target The Intent that the user will be selecting an activity
873 * to perform.
874 * @param title Optional title that will be displayed in the chooser.
875 * @return Return a new Intent object that you can hand to
876 * {@link Context#startActivity(Intent) Context.startActivity()} and
877 * related methods.
878 */
879 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700880 return createChooser(target, title, null);
881 }
882
883 /**
884 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
885 *
886 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
887 * target intent, also optionally supplying a title. If the target
888 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
889 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
890 * set in the returned chooser intent, with its ClipData set appropriately:
891 * either a direct reflection of {@link #getClipData()} if that is non-null,
892 * or a new ClipData built from {@link #getData()}.</p>
893 *
894 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
895 * when the user makes a choice. This can be useful if the calling application wants
896 * to remember the last chosen target and surface it as a more prominent or one-touch
897 * affordance elsewhere in the UI for next time.</p>
898 *
899 * @param target The Intent that the user will be selecting an activity
900 * to perform.
901 * @param title Optional title that will be displayed in the chooser.
902 * @param sender Optional IntentSender to be called when a choice is made.
903 * @return Return a new Intent object that you can hand to
904 * {@link Context#startActivity(Intent) Context.startActivity()} and
905 * related methods.
906 */
907 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700908 Intent intent = new Intent(ACTION_CHOOSER);
909 intent.putExtra(EXTRA_INTENT, target);
910 if (title != null) {
911 intent.putExtra(EXTRA_TITLE, title);
912 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700913
Adam Powell0b3c1122014-10-09 12:50:14 -0700914 if (sender != null) {
915 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
916 }
917
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700918 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700919 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
920 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
921 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700922 if (permFlags != 0) {
923 ClipData targetClipData = target.getClipData();
924 if (targetClipData == null && target.getData() != null) {
925 ClipData.Item item = new ClipData.Item(target.getData());
926 String[] mimeTypes;
927 if (target.getType() != null) {
928 mimeTypes = new String[] { target.getType() };
929 } else {
930 mimeTypes = new String[] { };
931 }
932 targetClipData = new ClipData(null, mimeTypes, item);
933 }
934 if (targetClipData != null) {
935 intent.setClipData(targetClipData);
936 intent.addFlags(permFlags);
937 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700938 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700939
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700940 return intent;
941 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700942
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700943 /**
944 * Activity Action: Allow the user to select a particular kind of data and
945 * return it. This is different than {@link #ACTION_PICK} in that here we
946 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800947 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700948 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900949 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700950 * etc.
951 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900952 * 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 -0700953 * of data, such as a person contact, you set the MIME type to the kind of
954 * data you want and launch it with {@link Context#startActivity(Intent)}.
955 * The system will then launch the best application to select that kind
956 * of data for you.
957 * <p>
958 * You may also be interested in any of a set of types of content the user
959 * can pick. For example, an e-mail application that wants to allow the
960 * user to add an attachment to an e-mail message can use this action to
961 * bring up a list of all of the types of content the user can attach.
962 * <p>
963 * In this case, you should wrap the GET_CONTENT intent with a chooser
964 * (through {@link #createChooser}), which will give the proper interface
965 * for the user to pick how to send your data and allow you to specify
966 * a prompt indicating what they are doing. You will usually specify a
967 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
968 * broad range of content types the user can select from.
969 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900970 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700971 * only pick from data that can be represented as a stream. This is
972 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
973 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800974 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900975 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800976 * is locally available on the device. For example, if this extra is set
977 * to true then an image picker should not show any pictures that are available
978 * from a remote server but not already on the local device (thus requiring
979 * they be downloaded when opened).
980 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800981 * If the caller can handle multiple returned items (the user performing
982 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
983 * to indicate this.
984 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700985 * Input: {@link #getType} is the desired MIME type to retrieve. Note
986 * that no URI is supplied in the intent, as there are no constraints on
987 * where the returned data originally comes from. You may also include the
988 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800989 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800990 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
991 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700992 * <p>
993 * Output: The URI of the item that was picked. This must be a content:
994 * URI so that any receiver can access it.
995 */
996 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
997 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
998 /**
999 * Activity Action: Dial a number as specified by the data. This shows a
1000 * UI with the number being dialed, allowing the user to explicitly
1001 * initiate the call.
1002 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1003 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1004 * number.
1005 * <p>Output: nothing.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1009 /**
1010 * Activity Action: Perform a call to someone specified by the data.
1011 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1012 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1013 * number.
1014 * <p>Output: nothing.
1015 *
1016 * <p>Note: there will be restrictions on which applications can initiate a
1017 * call; most applications should use the {@link #ACTION_DIAL}.
1018 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1019 * numbers. Applications can <strong>dial</strong> emergency numbers using
1020 * {@link #ACTION_DIAL}, however.
1021 */
1022 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1023 public static final String ACTION_CALL = "android.intent.action.CALL";
1024 /**
1025 * Activity Action: Perform a call to an emergency number specified by the
1026 * data.
1027 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1028 * tel: URI of an explicit phone number.
1029 * <p>Output: nothing.
1030 * @hide
1031 */
1032 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1033 /**
1034 * Activity action: Perform a call to any number (emergency or not)
1035 * specified by the data.
1036 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1037 * tel: URI of an explicit phone number.
1038 * <p>Output: nothing.
1039 * @hide
1040 */
1041 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1042 /**
1043 * Activity Action: Send a message to someone specified by the data.
1044 * <p>Input: {@link #getData} is URI describing the target.
1045 * <p>Output: nothing.
1046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1049 /**
1050 * Activity Action: Deliver some data to someone else. Who the data is
1051 * being delivered to is not specified; it is up to the receiver of this
1052 * action to ask the user where the data should be sent.
1053 * <p>
1054 * When launching a SEND intent, you should usually wrap it in a chooser
1055 * (through {@link #createChooser}), which will give the proper interface
1056 * for the user to pick how to send your data and allow you to specify
1057 * a prompt indicating what they are doing.
1058 * <p>
1059 * Input: {@link #getType} is the MIME type of the data being sent.
1060 * get*Extra can have either a {@link #EXTRA_TEXT}
1061 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1062 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1063 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1064 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001065 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1066 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1067 * your text with HTML formatting.
1068 * <p>
1069 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1070 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1071 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1072 * content: URIs and other advanced features of {@link ClipData}. If
1073 * using this approach, you still must supply the same data through the
1074 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1075 * for compatibility with old applications. If you don't set a ClipData,
1076 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001077 * <p>
1078 * Optional standard extras, which may be interpreted by some recipients as
1079 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1080 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1081 * <p>
1082 * Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_SEND = "android.intent.action.SEND";
1086 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001087 * Activity Action: Deliver multiple data to someone else.
1088 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001089 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001090 * <p>
1091 * Input: {@link #getType} is the MIME type of the data being sent.
1092 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001093 * #EXTRA_STREAM} field, containing the data to be sent. If using
1094 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1095 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001096 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001097 * Multiple types are supported, and receivers should handle mixed types
1098 * whenever possible. The right way for the receiver to check them is to
1099 * use the content resolver on each URI. The intent sender should try to
1100 * put the most concrete mime type in the intent type, but it can fall
1101 * back to {@literal <type>/*} or {@literal *}/* as needed.
1102 * <p>
1103 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1104 * be image/jpg, but if you are sending image/jpg and image/png, then the
1105 * intent's type should be image/*.
1106 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001107 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1108 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1109 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1110 * content: URIs and other advanced features of {@link ClipData}. If
1111 * using this approach, you still must supply the same data through the
1112 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1113 * for compatibility with old applications. If you don't set a ClipData,
1114 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1115 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001116 * Optional standard extras, which may be interpreted by some recipients as
1117 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1118 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1119 * <p>
1120 * Output: nothing.
1121 */
1122 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1123 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1124 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001125 * Activity Action: Handle an incoming phone call.
1126 * <p>Input: nothing.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1131 /**
1132 * Activity Action: Insert an empty item into the given container.
1133 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1134 * in which to place the data.
1135 * <p>Output: URI of the new data that was created.
1136 */
1137 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1138 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1139 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001140 * Activity Action: Create a new item in the given container, initializing it
1141 * from the current contents of the clipboard.
1142 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1143 * in which to place the data.
1144 * <p>Output: URI of the new data that was created.
1145 */
1146 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1147 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1148 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001149 * Activity Action: Delete the given data from its container.
1150 * <p>Input: {@link #getData} is URI of data to be deleted.
1151 * <p>Output: nothing.
1152 */
1153 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1154 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1155 /**
1156 * Activity Action: Run the data, whatever that means.
1157 * <p>Input: ? (Note: this is currently specific to the test harness.)
1158 * <p>Output: nothing.
1159 */
1160 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1161 public static final String ACTION_RUN = "android.intent.action.RUN";
1162 /**
1163 * Activity Action: Perform a data synchronization.
1164 * <p>Input: ?
1165 * <p>Output: ?
1166 */
1167 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1168 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1169 /**
1170 * Activity Action: Pick an activity given an intent, returning the class
1171 * selected.
1172 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1173 * used with {@link PackageManager#queryIntentActivities} to determine the
1174 * set of activities from which to pick.
1175 * <p>Output: Class name of the activity that was selected.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1179 /**
1180 * Activity Action: Perform a search.
1181 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1182 * is the text to search for. If empty, simply
1183 * enter your search results Activity with the search UI activated.
1184 * <p>Output: nothing.
1185 */
1186 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1187 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1188 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001189 * Activity Action: Start the platform-defined tutorial
1190 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1191 * is the text to search for. If empty, simply
1192 * enter your search results Activity with the search UI activated.
1193 * <p>Output: nothing.
1194 */
1195 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1196 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1197 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001198 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001199 * <p>
1200 * Input: {@link android.app.SearchManager#QUERY
1201 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1202 * a url starts with http or https, the site will be opened. If it is plain
1203 * text, Google search will be applied.
1204 * <p>
1205 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001206 */
1207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1208 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001209
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001210 /**
Jim Miller07994402012-05-02 14:22:27 -07001211 * Activity Action: Perform assist action.
1212 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001213 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1214 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001215 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001216 * Output: nothing.
1217 */
1218 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1219 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001220
1221 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001222 * Activity Action: Perform voice assist action.
1223 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001224 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1225 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001226 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001227 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001228 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001229 */
1230 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1231 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1232
1233 /**
Adam Skory7140a252013-09-11 12:04:58 +01001234 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1235 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001236 */
1237 public static final String EXTRA_ASSIST_PACKAGE
1238 = "android.intent.extra.ASSIST_PACKAGE";
1239
1240 /**
Adam Skory7140a252013-09-11 12:04:58 +01001241 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1242 * information supplied by the current foreground app at the time of the assist request.
1243 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001244 */
1245 public static final String EXTRA_ASSIST_CONTEXT
1246 = "android.intent.extra.ASSIST_CONTEXT";
1247
Jim Miller07994402012-05-02 14:22:27 -07001248 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001249 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1250 * keyboard as the primary input device for assistance.
1251 */
1252 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1253 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1254
1255 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001256 * Activity Action: List all available applications
1257 * <p>Input: Nothing.
1258 * <p>Output: nothing.
1259 */
1260 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1261 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1262 /**
1263 * Activity Action: Show settings for choosing wallpaper
1264 * <p>Input: Nothing.
1265 * <p>Output: Nothing.
1266 */
1267 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1268 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1269
1270 /**
1271 * Activity Action: Show activity for reporting a bug.
1272 * <p>Input: Nothing.
1273 * <p>Output: Nothing.
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1277
1278 /**
1279 * Activity Action: Main entry point for factory tests. Only used when
1280 * the device is booting in factory test node. The implementing package
1281 * must be installed in the system image.
1282 * <p>Input: nothing
1283 * <p>Output: nothing
1284 */
1285 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1286
1287 /**
1288 * Activity Action: The user pressed the "call" button to go to the dialer
1289 * or other appropriate UI for placing a call.
1290 * <p>Input: Nothing.
1291 * <p>Output: Nothing.
1292 */
1293 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1294 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1295
1296 /**
1297 * Activity Action: Start Voice Command.
1298 * <p>Input: Nothing.
1299 * <p>Output: Nothing.
1300 */
1301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1302 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001303
1304 /**
1305 * Activity Action: Start action associated with long pressing on the
1306 * search key.
1307 * <p>Input: Nothing.
1308 * <p>Output: Nothing.
1309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001312
Jacek Surazski86b6c532009-05-13 14:38:28 +02001313 /**
1314 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1315 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001316 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001317 * <p>Input: No data is specified. The bug report is passed in using
1318 * an {@link #EXTRA_BUG_REPORT} field.
1319 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001320 *
1321 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001322 */
1323 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1324 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001325
1326 /**
1327 * Activity Action: Show power usage information to the user.
1328 * <p>Input: Nothing.
1329 * <p>Output: Nothing.
1330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001333
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001334 /**
1335 * Activity Action: Setup wizard to launch after a platform update. This
1336 * activity should have a string meta-data field associated with it,
1337 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1338 * the platform for setup. The activity will be launched only if
1339 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1340 * same value.
1341 * <p>Input: Nothing.
1342 * <p>Output: Nothing.
1343 * @hide
1344 */
1345 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1346 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001347
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001348 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001349 * Activity Action: Show settings for managing network data usage of a
1350 * specific application. Applications should define an activity that offers
1351 * options to control data usage.
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_MANAGE_NETWORK_USAGE =
1355 "android.intent.action.MANAGE_NETWORK_USAGE";
1356
1357 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001358 * Activity Action: Launch application installer.
1359 * <p>
1360 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001361 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1362 * you can also use "package:<package-name>" to install an application for the
1363 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001364 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1365 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1366 * <p>
1367 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1368 * succeeded.
1369 *
1370 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1371 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1372 * @see #EXTRA_RETURN_RESULT
1373 */
1374 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1375 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1376
1377 /**
1378 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1379 * package. Specifies the installer package name; this package will receive the
1380 * {@link #ACTION_APP_ERROR} intent.
1381 */
1382 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1383 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1384
1385 /**
1386 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1387 * package. Specifies that the application being installed should not be
1388 * treated as coming from an unknown source, but as coming from the app
1389 * invoking the Intent. For this to work you must start the installer with
1390 * startActivityForResult().
1391 */
1392 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1393 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1394
1395 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001396 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1397 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001398 * data field originated from.
1399 */
rich cannings706e8ba2012-08-20 13:20:14 -07001400 public static final String EXTRA_ORIGINATING_URI
1401 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001402
1403 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001404 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1405 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1406 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001407 */
1408 public static final String EXTRA_REFERRER
1409 = "android.intent.extra.REFERRER";
1410
1411 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001412 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1413 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1414 * @hide
1415 */
1416 public static final String EXTRA_ORIGINATING_UID
1417 = "android.intent.extra.ORIGINATING_UID";
1418
1419 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001420 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1421 * package. Tells the installer UI to skip the confirmation with the user
1422 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001423 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1424 * will no longer show an interstitial message about updating existing
1425 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001426 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001427 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001428 public static final String EXTRA_ALLOW_REPLACE
1429 = "android.intent.extra.ALLOW_REPLACE";
1430
1431 /**
1432 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1433 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1434 * return to the application the result code of the install/uninstall. The returned result
1435 * code will be {@link android.app.Activity#RESULT_OK} on success or
1436 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1437 */
1438 public static final String EXTRA_RETURN_RESULT
1439 = "android.intent.extra.RETURN_RESULT";
1440
1441 /**
1442 * Package manager install result code. @hide because result codes are not
1443 * yet ready to be exposed.
1444 */
1445 public static final String EXTRA_INSTALL_RESULT
1446 = "android.intent.extra.INSTALL_RESULT";
1447
1448 /**
1449 * Activity Action: Launch application uninstaller.
1450 * <p>
1451 * Input: The data must be a package: URI whose scheme specific part is
1452 * the package name of the current installed package to be uninstalled.
1453 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1454 * <p>
1455 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1456 * succeeded.
1457 */
1458 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1459 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1460
1461 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001462 * Specify whether the package should be uninstalled for all users.
1463 * @hide because these should not be part of normal application flow.
1464 */
1465 public static final String EXTRA_UNINSTALL_ALL_USERS
1466 = "android.intent.extra.UNINSTALL_ALL_USERS";
1467
1468 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001469 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1470 * describing the last run version of the platform that was setup.
1471 * @hide
1472 */
1473 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1474
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001475 // ---------------------------------------------------------------------
1476 // ---------------------------------------------------------------------
1477 // Standard intent broadcast actions (see action variable).
1478
1479 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001480 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1481 * <p>
1482 * For historical reasons, the name of this broadcast action refers to the power
1483 * state of the screen but it is actually sent in response to changes in the
1484 * overall interactive state of the device.
1485 * </p><p>
1486 * This broadcast is sent when the device becomes non-interactive which may have
1487 * nothing to do with the screen turning off. To determine the
1488 * actual state of the screen, use {@link android.view.Display#getState}.
1489 * </p><p>
1490 * See {@link android.os.PowerManager#isInteractive} for details.
1491 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001492 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001493 * <p class="note">This is a protected intent that can only be sent
1494 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001498
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001499 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001500 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1501 * <p>
1502 * For historical reasons, the name of this broadcast action refers to the power
1503 * state of the screen but it is actually sent in response to changes in the
1504 * overall interactive state of the device.
1505 * </p><p>
1506 * This broadcast is sent when the device becomes interactive which may have
1507 * nothing to do with the screen turning on. To determine the
1508 * actual state of the screen, use {@link android.view.Display#getState}.
1509 * </p><p>
1510 * See {@link android.os.PowerManager#isInteractive} for details.
1511 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001512 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001513 * <p class="note">This is a protected intent that can only be sent
1514 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001515 */
1516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1517 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001518
1519 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001520 * Broadcast Action: Sent after the system stops dreaming.
1521 *
1522 * <p class="note">This is a protected intent that can only be sent by the system.
1523 * It is only sent to registered receivers.</p>
1524 */
1525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1526 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1527
1528 /**
1529 * Broadcast Action: Sent after the system starts dreaming.
1530 *
1531 * <p class="note">This is a protected intent that can only be sent by the system.
1532 * It is only sent to registered receivers.</p>
1533 */
1534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1535 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1536
1537 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001538 * 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 -07001539 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001540 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001541 * <p class="note">This is a protected intent that can only be sent
1542 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001543 */
1544 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001545 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001546
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001547 /**
1548 * Broadcast Action: The current time has changed. Sent every
1549 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001550 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001551 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1552 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001553 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001554 * <p class="note">This is a protected intent that can only be sent
1555 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001556 */
1557 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1558 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1559 /**
1560 * Broadcast Action: The time was set.
1561 */
1562 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1563 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1564 /**
1565 * Broadcast Action: The date has changed.
1566 */
1567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1568 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1569 /**
1570 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1571 * <ul>
1572 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1573 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001574 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001575 * <p class="note">This is a protected intent that can only be sent
1576 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001577 */
1578 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1579 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1580 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001581 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1582 * DNS entries should be tossed.
1583 * @hide
1584 */
1585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1586 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1587 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001588 * Alarm Changed Action: This is broadcast when the AlarmClock
1589 * application's alarm is set or unset. It is used by the
1590 * AlarmClock application and the StatusBar service.
1591 * @hide
1592 */
1593 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1594 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1595 /**
1596 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1597 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1598 * @hide
1599 */
1600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1601 public static final String ACTION_SYNC_STATE_CHANGED
1602 = "android.intent.action.SYNC_STATE_CHANGED";
1603 /**
1604 * Broadcast Action: This is broadcast once, after the system has finished
1605 * booting. It can be used to perform application-specific initialization,
1606 * such as installing alarms. You must hold the
1607 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1608 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001609 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001610 * <p class="note">This is a protected intent that can only be sent
1611 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001612 */
1613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1614 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1615 /**
1616 * Broadcast Action: This is broadcast when a user action should request a
1617 * temporary system dialog to dismiss. Some examples of temporary system
1618 * dialogs are the notification window-shade and the recent tasks dialog.
1619 */
1620 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1621 /**
1622 * Broadcast Action: Trigger the download and eventual installation
1623 * of a package.
1624 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001625 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001626 * <p class="note">This is a protected intent that can only be sent
1627 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001628 *
1629 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001630 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001631 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001632 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1633 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1634 /**
1635 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001636 * device. The data contains the name of the package. Note that the
1637 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001638 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001639 * <ul>
1640 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1641 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1642 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1643 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001644 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001645 * <p class="note">This is a protected intent that can only be sent
1646 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001647 */
1648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1649 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1650 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001651 * Broadcast Action: A new version of an application package has been
1652 * installed, replacing an existing version that was previously installed.
1653 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001654 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001655 * <ul>
1656 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1657 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001658 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001659 * <p class="note">This is a protected intent that can only be sent
1660 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001661 */
1662 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1663 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1664 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001665 * Broadcast Action: A new version of your application has been installed
1666 * over an existing one. This is only sent to the application that was
1667 * replaced. It does not contain any additional data; to receive it, just
1668 * use an intent filter for this action.
1669 *
1670 * <p class="note">This is a protected intent that can only be sent
1671 * by the system.
1672 */
1673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1674 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001676 * Broadcast Action: An existing application package has been removed from
1677 * the device. The data contains the name of the package. The package
1678 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001679 * <ul>
1680 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1681 * to the package.
1682 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1683 * application -- data and code -- is being removed.
1684 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1685 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1686 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001687 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001688 * <p class="note">This is a protected intent that can only be sent
1689 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001690 */
1691 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1692 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1693 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001694 * Broadcast Action: An existing application package has been completely
1695 * removed from the device. The data contains the name of the package.
1696 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1697 * {@link #EXTRA_DATA_REMOVED} is true and
1698 * {@link #EXTRA_REPLACING} is false of that broadcast.
1699 *
1700 * <ul>
1701 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1702 * to the package.
1703 * </ul>
1704 *
1705 * <p class="note">This is a protected intent that can only be sent
1706 * by the system.
1707 */
1708 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1709 public static final String ACTION_PACKAGE_FULLY_REMOVED
1710 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1711 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001712 * Broadcast Action: An existing application package has been changed (e.g.
1713 * a component has been enabled or disabled). The data contains the name of
1714 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001715 * <ul>
1716 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001717 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001718 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001719 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1720 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001721 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001722 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001723 * <p class="note">This is a protected intent that can only be sent
1724 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001725 */
1726 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1727 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1728 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001729 * @hide
1730 * Broadcast Action: Ask system services if there is any reason to
1731 * restart the given package. The data contains the name of the
1732 * package.
1733 * <ul>
1734 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1735 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1736 * </ul>
1737 *
1738 * <p class="note">This is a protected intent that can only be sent
1739 * by the system.
1740 */
1741 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1742 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1743 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001744 * Broadcast Action: The user has restarted a package, and all of its
1745 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001746 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001747 * be removed. Note that the restarted package does <em>not</em>
1748 * receive this broadcast.
1749 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001750 * <ul>
1751 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1752 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001753 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001754 * <p class="note">This is a protected intent that can only be sent
1755 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001756 */
1757 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1758 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1759 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001760 * Broadcast Action: The user has cleared the data of a package. This should
1761 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001762 * its persistent data is erased and this broadcast sent.
1763 * Note that the cleared package does <em>not</em>
1764 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001765 * <ul>
1766 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1767 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001768 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001769 * <p class="note">This is a protected intent that can only be sent
1770 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1773 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1774 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001775 * Broadcast Action: A user ID has been removed from the system. The user
1776 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001777 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001778 * <p class="note">This is a protected intent that can only be sent
1779 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001780 */
1781 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1782 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001783
1784 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001785 * Broadcast Action: Sent to the installer package of an application
1786 * when that application is first launched (that is the first time it
1787 * is moved out of the stopped state). The data contains the name of the package.
1788 *
1789 * <p class="note">This is a protected intent that can only be sent
1790 * by the system.
1791 */
1792 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1793 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1794
1795 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001796 * Broadcast Action: Sent to the system package verifier when a package
1797 * needs to be verified. The data contains the package URI.
1798 * <p class="note">
1799 * This is a protected intent that can only be sent by the system.
1800 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001801 */
1802 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1803 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1804
1805 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001806 * Broadcast Action: Sent to the system package verifier when a package is
1807 * verified. The data contains the package URI.
1808 * <p class="note">
1809 * This is a protected intent that can only be sent by the system.
1810 */
1811 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1812 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1813
1814 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001815 * Broadcast Action: Resources for a set of packages (which were
1816 * previously unavailable) are currently
1817 * available since the media on which they exist is available.
1818 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1819 * list of packages whose availability changed.
1820 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1821 * list of uids of packages whose availability changed.
1822 * Note that the
1823 * packages in this list do <em>not</em> receive this broadcast.
1824 * The specified set of packages are now available on the system.
1825 * <p>Includes the following extras:
1826 * <ul>
1827 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1828 * whose resources(were previously unavailable) are currently available.
1829 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1830 * packages whose resources(were previously unavailable)
1831 * are currently available.
1832 * </ul>
1833 *
1834 * <p class="note">This is a protected intent that can only be sent
1835 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001836 */
1837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001838 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1839 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001840
1841 /**
1842 * Broadcast Action: Resources for a set of packages are currently
1843 * unavailable since the media on which they exist is unavailable.
1844 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1845 * list of packages whose availability changed.
1846 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1847 * list of uids of packages whose availability changed.
1848 * The specified set of packages can no longer be
1849 * launched and are practically unavailable on the system.
1850 * <p>Inclues the following extras:
1851 * <ul>
1852 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1853 * whose resources are no longer available.
1854 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1855 * whose resources are no longer available.
1856 * </ul>
1857 *
1858 * <p class="note">This is a protected intent that can only be sent
1859 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001860 */
1861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001862 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001863 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001864
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001865 /**
1866 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001867 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001868 * This should <em>only</em> be used to determine when the wallpaper
1869 * has changed to show the new wallpaper to the user. You should certainly
1870 * never, in response to this, change the wallpaper or other attributes of
1871 * it such as the suggested size. That would be crazy, right? You'd cause
1872 * all kinds of loops, especially if other apps are doing similar things,
1873 * right? Of course. So please don't do this.
1874 *
1875 * @deprecated Modern applications should use
1876 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1877 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1878 * shown behind their UI, rather than watching for this broadcast and
1879 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001880 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001881 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001882 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1883 /**
1884 * Broadcast Action: The current device {@link android.content.res.Configuration}
1885 * (orientation, locale, etc) has changed. When such a change happens, the
1886 * UIs (view hierarchy) will need to be rebuilt based on this new
1887 * information; for the most part, applications don't need to worry about
1888 * this, because the system will take care of stopping and restarting the
1889 * application to make sure it sees the new changes. Some system code that
1890 * can not be restarted will need to watch for this action and handle it
1891 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001892 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001893 * <p class="note">
1894 * You can <em>not</em> receive this through components declared
1895 * in manifests, only by explicitly registering for it with
1896 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1897 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001898 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001899 * <p class="note">This is a protected intent that can only be sent
1900 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001901 *
1902 * @see android.content.res.Configuration
1903 */
1904 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1905 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1906 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001907 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001908 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001909 * <p class="note">This is a protected intent that can only be sent
1910 * by the system.
1911 */
1912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1913 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1914 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001915 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1916 * charging state, level, and other information about the battery.
1917 * See {@link android.os.BatteryManager} for documentation on the
1918 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001919 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001920 * <p class="note">
1921 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001922 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001924 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1925 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1926 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1927 * broadcasts that are sent and can be received through manifest
1928 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001929 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001930 * <p class="note">This is a protected intent that can only be sent
1931 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001932 */
1933 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1934 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1935 /**
1936 * Broadcast Action: Indicates low battery condition on the device.
1937 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001938 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001939 * <p class="note">This is a protected intent that can only be sent
1940 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1944 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001945 * Broadcast Action: Indicates the battery is now okay after being low.
1946 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1947 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001948 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001949 * <p class="note">This is a protected intent that can only be sent
1950 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1954 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001955 * Broadcast Action: External power has been connected to the device.
1956 * This is intended for applications that wish to register specifically to this notification.
1957 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1958 * stay active to receive this notification. This action can be used to implement actions
1959 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001960 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001961 * <p class="note">This is a protected intent that can only be sent
1962 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001963 */
1964 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001965 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001966 /**
1967 * Broadcast Action: External power has been removed from the device.
1968 * This is intended for applications that wish to register specifically to this notification.
1969 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1970 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001971 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001972 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001973 * <p class="note">This is a protected intent that can only be sent
1974 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001975 */
1976 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001977 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001978 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001979 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001980 * Broadcast Action: Device is shutting down.
1981 * This is broadcast when the device is being shut down (completely turned
1982 * off, not sleeping). Once the broadcast is complete, the final shutdown
1983 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001984 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001985 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001986 * <p class="note">This is a protected intent that can only be sent
1987 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001988 * <p>May include the following extras:
1989 * <ul>
1990 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1991 * shutdown is only for userspace processes. If not set, assumed to be false.
1992 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001995 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001996 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001997 * Activity Action: Start this activity to request system shutdown.
1998 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1999 * to request confirmation from the user before shutting down.
2000 *
2001 * <p class="note">This is a protected intent that can only be sent
2002 * by the system.
2003 *
2004 * {@hide}
2005 */
2006 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2007 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002008 * Broadcast Action: A sticky broadcast that indicates low memory
2009 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002010 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002011 * <p class="note">This is a protected intent that can only be sent
2012 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002013 */
2014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2016 /**
2017 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002018 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002019 * <p class="note">This is a protected intent that can only be sent
2020 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2024 /**
Jake Hambybb371632010-08-23 18:16:48 -07002025 * Broadcast Action: A sticky broadcast that indicates a memory full
2026 * condition on the device. This is intended for activities that want
2027 * to be able to fill the data partition completely, leaving only
2028 * enough free space to prevent system-wide SQLite failures.
2029 *
2030 * <p class="note">This is a protected intent that can only be sent
2031 * by the system.
2032 *
2033 * {@hide}
2034 */
2035 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2036 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2037 /**
2038 * Broadcast Action: Indicates memory full condition on the device
2039 * no longer exists.
2040 *
2041 * <p class="note">This is a protected intent that can only be sent
2042 * by the system.
2043 *
2044 * {@hide}
2045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2047 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2048 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002049 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2050 * and package management should be started.
2051 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2052 * notification.
2053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2056 /**
2057 * Broadcast Action: The device has entered USB Mass Storage mode.
2058 * This is used mainly for the USB Settings panel.
2059 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2060 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002061 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002062 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002063 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2065
2066 /**
2067 * Broadcast Action: The device has exited USB Mass Storage mode.
2068 * This is used mainly for the USB Settings panel.
2069 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2070 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002071 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002072 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002073 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2075
2076 /**
2077 * Broadcast Action: External media has been removed.
2078 * The path to the mount point for the removed media is contained in the Intent.mData field.
2079 */
2080 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2081 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2082
2083 /**
2084 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002085 * 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 -07002086 */
2087 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2088 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2089
2090 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002091 * Broadcast Action: External media is present, and being disk-checked
2092 * 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 -08002093 */
2094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2096
2097 /**
2098 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2099 * 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 -08002100 */
2101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2102 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2103
2104 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002106 * 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 -07002107 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2108 * media was mounted read only.
2109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2112
2113 /**
2114 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002115 * 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 -07002116 */
2117 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2118 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2119
2120 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002121 * Broadcast Action: External media is no longer being shared via USB mass storage.
2122 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2123 *
2124 * @hide
2125 */
2126 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2127
2128 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002129 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2130 * The path to the mount point for the removed media is contained in the Intent.mData field.
2131 */
2132 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2133 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2134
2135 /**
2136 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002137 * 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 -07002138 */
2139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2140 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2141
2142 /**
2143 * Broadcast Action: User has expressed the desire to remove the external storage media.
2144 * Applications should close all files they have open within the mount point when they receive this intent.
2145 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2146 */
2147 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2148 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2149
2150 /**
2151 * Broadcast Action: The media scanner has started scanning a directory.
2152 * The path to the directory being scanned is contained in the Intent.mData field.
2153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2156
2157 /**
2158 * Broadcast Action: The media scanner has finished scanning a directory.
2159 * The path to the scanned directory is contained in the Intent.mData field.
2160 */
2161 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2162 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2163
2164 /**
2165 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2166 * The path to the file is contained in the Intent.mData field.
2167 */
2168 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2169 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2170
2171 /**
2172 * Broadcast Action: The "Media Button" was pressed. Includes a single
2173 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2174 * caused the broadcast.
2175 */
2176 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2177 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2178
2179 /**
2180 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2181 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2182 * caused the broadcast.
2183 */
2184 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2185 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2186
2187 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2188 // location; they are not general-purpose actions.
2189
2190 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002191 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002192 */
2193 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2194 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2195 "android.intent.action.GTALK_CONNECTED";
2196
2197 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002198 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002199 */
2200 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2201 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2202 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002203
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002204 /**
2205 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002206 */
2207 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2208 public static final String ACTION_INPUT_METHOD_CHANGED =
2209 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002210
2211 /**
2212 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2213 * more radios have been turned off or on. The intent will have the following extra value:</p>
2214 * <ul>
2215 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2216 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2217 * turned off</li>
2218 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002219 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002220 * <p class="note">This is a protected intent that can only be sent
2221 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002222 */
2223 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2224 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2225
2226 /**
2227 * Broadcast Action: Some content providers have parts of their namespace
2228 * where they publish new events or items that the user may be especially
2229 * interested in. For these things, they may broadcast this action when the
2230 * set of interesting items change.
2231 *
2232 * For example, GmailProvider sends this notification when the set of unread
2233 * mail in the inbox changes.
2234 *
2235 * <p>The data of the intent identifies which part of which provider
2236 * changed. When queried through the content resolver, the data URI will
2237 * return the data set in question.
2238 *
2239 * <p>The intent will have the following extra values:
2240 * <ul>
2241 * <li><em>count</em> - The number of items in the data set. This is the
2242 * same as the number of items in the cursor returned by querying the
2243 * data URI. </li>
2244 * </ul>
2245 *
2246 * This intent will be sent at boot (if the count is non-zero) and when the
2247 * data set changes. It is possible for the data set to change without the
2248 * count changing (for example, if a new unread message arrives in the same
2249 * sync operation in which a message is archived). The phone should still
2250 * ring/vibrate/etc as normal in this case.
2251 */
2252 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2253 public static final String ACTION_PROVIDER_CHANGED =
2254 "android.intent.action.PROVIDER_CHANGED";
2255
2256 /**
2257 * Broadcast Action: Wired Headset plugged in or unplugged.
2258 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002259 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2260 * and documentation.
2261 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002262 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002263 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 */
2265 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002266 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002267
2268 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002269 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2270 * <ul>
2271 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2272 * </ul>
2273 *
2274 * <p class="note">This is a protected intent that can only be sent
2275 * by the system.
2276 *
2277 * @hide
2278 */
2279 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2280 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2281 = "android.intent.action.ADVANCED_SETTINGS";
2282
2283 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002284 * Broadcast Action: Sent after application restrictions are changed.
2285 *
2286 * <p class="note">This is a protected intent that can only be sent
2287 * by the system.</p>
2288 */
2289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2290 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2291 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2292
2293 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002294 * Broadcast Action: An outgoing call is about to be placed.
2295 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002296 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002297 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002298 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002299 * the phone number originally intended to be dialed.</li>
2300 * </ul>
2301 * <p>Once the broadcast is finished, the resultData is used as the actual
2302 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002303 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 * outgoing call in turn: for example, a parental control application
2305 * might verify that the user is authorized to place the call at that
2306 * time, then a number-rewriting application might add an area code if
2307 * one was not specified.</p>
2308 * <p>For consistency, any receiver whose purpose is to prohibit phone
2309 * calls should have a priority of 0, to ensure it will see the final
2310 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002311 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002312 * should have a positive priority.
2313 * Negative priorities are reserved for the system for this broadcast;
2314 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002315 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2316 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002317 * <p>Emergency calls cannot be intercepted using this mechanism, and
2318 * other calls cannot be modified to call emergency numbers using this
2319 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002320 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2321 * call to use their own service instead. Those apps should first prevent
2322 * the call from being placed by setting resultData to <code>null</code>
2323 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002324 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002325 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2326 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002327 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002328 * <p class="note">This is a protected intent that can only be sent
2329 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002330 */
2331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2332 public static final String ACTION_NEW_OUTGOING_CALL =
2333 "android.intent.action.NEW_OUTGOING_CALL";
2334
2335 /**
2336 * Broadcast Action: Have the device reboot. This is only for use by
2337 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002338 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002339 * <p class="note">This is a protected intent that can only be sent
2340 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002341 */
2342 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2343 public static final String ACTION_REBOOT =
2344 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002345
Wei Huang97ecc9c2009-05-11 17:44:20 -07002346 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002347 * Broadcast Action: A sticky broadcast for changes in the physical
2348 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002349 *
2350 * <p>The intent will have the following extra values:
2351 * <ul>
2352 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002353 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002354 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002355 * <p>This is intended for monitoring the current physical dock state.
2356 * See {@link android.app.UiModeManager} for the normal API dealing with
2357 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002358 */
2359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2360 public static final String ACTION_DOCK_EVENT =
2361 "android.intent.action.DOCK_EVENT";
2362
2363 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002364 * Broadcast Action: A broadcast when idle maintenance can be started.
2365 * This means that the user is not interacting with the device and is
2366 * not expected to do so soon. Typical use of the idle maintenance is
2367 * to perform somehow expensive tasks that can be postponed at a moment
2368 * when they will not degrade user experience.
2369 * <p>
2370 * <p class="note">In order to keep the device responsive in case of an
2371 * unexpected user interaction, implementations of a maintenance task
2372 * should be interruptible. In such a scenario a broadcast with action
2373 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2374 * should not do the maintenance work in
2375 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2376 * maintenance service by {@link Context#startService(Intent)}. Also
2377 * you should hold a wake lock while your maintenance service is running
2378 * to prevent the device going to sleep.
2379 * </p>
2380 * <p>
2381 * <p class="note">This is a protected intent that can only be sent by
2382 * the system.
2383 * </p>
2384 *
2385 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002386 *
2387 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002388 */
2389 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2390 public static final String ACTION_IDLE_MAINTENANCE_START =
2391 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2392
2393 /**
2394 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2395 * This means that the user was not interacting with the device as a result
2396 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2397 * was sent and now the user started interacting with the device. Typical
2398 * use of the idle maintenance is to perform somehow expensive tasks that
2399 * can be postponed at a moment when they will not degrade user experience.
2400 * <p>
2401 * <p class="note">In order to keep the device responsive in case of an
2402 * unexpected user interaction, implementations of a maintenance task
2403 * should be interruptible. Hence, on receiving a broadcast with this
2404 * action, the maintenance task should be interrupted as soon as possible.
2405 * In other words, you should not do the maintenance work in
2406 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2407 * maintenance service that was started on receiving of
2408 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2409 * lock you acquired when your maintenance service started.
2410 * </p>
2411 * <p class="note">This is a protected intent that can only be sent
2412 * by the system.
2413 *
2414 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002415 *
2416 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002417 */
2418 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2419 public static final String ACTION_IDLE_MAINTENANCE_END =
2420 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2421
2422 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002423 * Broadcast Action: a remote intent is to be broadcasted.
2424 *
2425 * A remote intent is used for remote RPC between devices. The remote intent
2426 * is serialized and sent from one device to another device. The receiving
2427 * device parses the remote intent and broadcasts it. Note that anyone can
2428 * broadcast a remote intent. However, if the intent receiver of the remote intent
2429 * does not trust intent broadcasts from arbitrary intent senders, it should require
2430 * the sender to hold certain permissions so only trusted sender's broadcast will be
2431 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002432 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002433 */
2434 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002435 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002436
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002437 /**
2438 * Broadcast Action: hook for permforming cleanup after a system update.
2439 *
2440 * The broadcast is sent when the system is booting, before the
2441 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2442 * image. A receiver for this should do its work and then disable itself
2443 * so that it does not get run again at the next boot.
2444 * @hide
2445 */
2446 public static final String ACTION_PRE_BOOT_COMPLETED =
2447 "android.intent.action.PRE_BOOT_COMPLETED";
2448
Amith Yamasani13593602012-03-22 16:16:17 -07002449 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002450 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002451 * on restricted users. The broadcast intent contains an extra
2452 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2453 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2454 * String[] depending on the restriction type.<p/>
2455 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002456 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2457 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2458 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002459 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2460 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002461 * @see RestrictionEntry
2462 */
2463 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2464 "android.intent.action.GET_RESTRICTION_ENTRIES";
2465
2466 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002467 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002468 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002469 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2470 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2471 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002472 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2473 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2474 * challenge.<p/>
2475 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002476 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002477 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002478 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2479 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002480
2481 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002482 * Sent the first time a user is starting, to allow system apps to
2483 * perform one time initialization. (This will not be seen by third
2484 * party applications because a newly initialized user does not have any
2485 * third party applications installed for it.) This is sent early in
2486 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002487 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2488 * broadcast, since it is part of a visible user interaction; be as quick
2489 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002490 */
2491 public static final String ACTION_USER_INITIALIZE =
2492 "android.intent.action.USER_INITIALIZE";
2493
2494 /**
2495 * Sent when a user switch is happening, causing the process's user to be
2496 * brought to the foreground. This is only sent to receivers registered
2497 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2498 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002499 * foreground. This is sent as a foreground
2500 * broadcast, since it is part of a visible user interaction; be as quick
2501 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002502 */
2503 public static final String ACTION_USER_FOREGROUND =
2504 "android.intent.action.USER_FOREGROUND";
2505
2506 /**
2507 * Sent when a user switch is happening, causing the process's user to be
2508 * sent to the background. This is only sent to receivers registered
2509 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2510 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002511 * background. This is sent as a foreground
2512 * broadcast, since it is part of a visible user interaction; be as quick
2513 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002514 */
2515 public static final String ACTION_USER_BACKGROUND =
2516 "android.intent.action.USER_BACKGROUND";
2517
2518 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002519 * Broadcast sent to the system when a user is added. Carries an extra
2520 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2521 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002522 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002523 * @hide
2524 */
2525 public static final String ACTION_USER_ADDED =
2526 "android.intent.action.USER_ADDED";
2527
2528 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002529 * Broadcast sent by the system when a user is started. Carries an extra
2530 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002531 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002532 * that has been started. This is sent as a foreground
2533 * broadcast, since it is part of a visible user interaction; be as quick
2534 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002535 * @hide
2536 */
2537 public static final String ACTION_USER_STARTED =
2538 "android.intent.action.USER_STARTED";
2539
2540 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002541 * Broadcast sent when a user is in the process of starting. Carries an extra
2542 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2543 * sent to registered receivers, not manifest receivers. It is sent to all
2544 * users (including the one that is being started). You must hold
2545 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2546 * this broadcast. This is sent as a background broadcast, since
2547 * its result is not part of the primary UX flow; to safely keep track of
2548 * started/stopped state of a user you can use this in conjunction with
2549 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2550 * other user state broadcasts since those are foreground broadcasts so can
2551 * execute in a different order.
2552 * @hide
2553 */
2554 public static final String ACTION_USER_STARTING =
2555 "android.intent.action.USER_STARTING";
2556
2557 /**
2558 * Broadcast sent when a user is going to be stopped. Carries an extra
2559 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2560 * sent to registered receivers, not manifest receivers. It is sent to all
2561 * users (including the one that is being stopped). You must hold
2562 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2563 * this broadcast. The user will not stop until all receivers have
2564 * handled the broadcast. This is sent as a background broadcast, since
2565 * its result is not part of the primary UX flow; to safely keep track of
2566 * started/stopped state of a user you can use this in conjunction with
2567 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2568 * other user state broadcasts since those are foreground broadcasts so can
2569 * execute in a different order.
2570 * @hide
2571 */
2572 public static final String ACTION_USER_STOPPING =
2573 "android.intent.action.USER_STOPPING";
2574
2575 /**
2576 * Broadcast sent to the system when a user is stopped. Carries an extra
2577 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2578 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2579 * specific package. This is only sent to registered receivers, not manifest
2580 * receivers. It is sent to all running users <em>except</em> the one that
2581 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002582 * @hide
2583 */
2584 public static final String ACTION_USER_STOPPED =
2585 "android.intent.action.USER_STOPPED";
2586
2587 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002588 * 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 -07002589 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002590 * one that has been removed. The user will not be completely removed until all receivers have
2591 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002592 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002593 * @hide
2594 */
2595 public static final String ACTION_USER_REMOVED =
2596 "android.intent.action.USER_REMOVED";
2597
2598 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002599 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002600 * the userHandle of the user to become the current one. This is only sent to
2601 * registered receivers, not manifest receivers. It is sent to all running users.
2602 * You must hold
2603 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002604 * @hide
2605 */
2606 public static final String ACTION_USER_SWITCHED =
2607 "android.intent.action.USER_SWITCHED";
2608
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002609 /**
2610 * Broadcast sent to the system when a user's information changes. Carries an extra
2611 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002612 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002613 * @hide
2614 */
2615 public static final String ACTION_USER_INFO_CHANGED =
2616 "android.intent.action.USER_INFO_CHANGED";
2617
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002618 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002619 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2620 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002621 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2622 * that need to display merged content across both primary and managed profiles need to
2623 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002624 * not manifest receivers.
2625 */
2626 public static final String ACTION_MANAGED_PROFILE_ADDED =
2627 "android.intent.action.MANAGED_PROFILE_ADDED";
2628
2629 /**
2630 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002631 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2632 * Only applications (for example Launchers) that need to display merged content across both
2633 * primary and managed profiles need to worry about this broadcast. This is only sent to
2634 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002635 */
2636 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2637 "android.intent.action.MANAGED_PROFILE_REMOVED";
2638
2639 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002640 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2641 */
2642 public static final String ACTION_QUICK_CLOCK =
2643 "android.intent.action.QUICK_CLOCK";
2644
Michael Wright0087a142013-02-05 16:29:39 -08002645 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002646 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002647 * @hide
2648 */
2649 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2650 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2651
Justin Kohd378ad72013-04-01 12:18:26 -07002652 /**
2653 * Broadcast Action: A global button was pressed. Includes a single
2654 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2655 * caused the broadcast.
2656 * @hide
2657 */
2658 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2659
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002660 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002661 * Activity Action: Allow the user to select and return one or more existing
2662 * documents. When invoked, the system will display the various
2663 * {@link DocumentsProvider} instances installed on the device, letting the
2664 * user interactively navigate through them. These documents include local
2665 * media, such as photos and video, and documents provided by installed
2666 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002667 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002668 * Each document is represented as a {@code content://} URI backed by a
2669 * {@link DocumentsProvider}, which can be opened as a stream with
2670 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2671 * {@link android.provider.DocumentsContract.Document} metadata.
2672 * <p>
2673 * All selected documents are returned to the calling application with
2674 * persistable read and write permission grants. If you want to maintain
2675 * access to the documents across device reboots, you need to explicitly
2676 * take the persistable permissions using
2677 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2678 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002679 * Callers must indicate the acceptable document MIME types through
2680 * {@link #setType(String)}. For example, to select photos, use
2681 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2682 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2683 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002684 * <p>
2685 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002686 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2687 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002688 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002689 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2690 * returned URIs can be opened with
2691 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002692 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002693 * Output: The URI of the item that was picked, returned in
2694 * {@link #getData()}. This must be a {@code content://} URI so that any
2695 * receiver can access it. If multiple documents were selected, they are
2696 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002697 *
2698 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002699 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002700 * @see #ACTION_CREATE_DOCUMENT
2701 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002702 */
2703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2704 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2705
2706 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002707 * Activity Action: Allow the user to create a new document. When invoked,
2708 * the system will display the various {@link DocumentsProvider} instances
2709 * installed on the device, letting the user navigate through them. The
2710 * returned document may be a newly created document with no content, or it
2711 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002712 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002713 * Each document is represented as a {@code content://} URI backed by a
2714 * {@link DocumentsProvider}, which can be opened as a stream with
2715 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2716 * {@link android.provider.DocumentsContract.Document} metadata.
2717 * <p>
2718 * Callers must indicate the concrete MIME type of the document being
2719 * created by setting {@link #setType(String)}. This MIME type cannot be
2720 * changed after the document is created.
2721 * <p>
2722 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2723 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002724 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002725 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2726 * returned URIs can be opened with
2727 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002728 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002729 * Output: The URI of the item that was created. This must be a
2730 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002731 *
2732 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002733 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002734 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002735 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002736 */
2737 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2738 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2739
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002740 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002741 * Activity Action: Allow the user to pick a directory subtree. When
2742 * invoked, the system will display the various {@link DocumentsProvider}
2743 * instances installed on the device, letting the user navigate through
2744 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002745 * <p>
2746 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002747 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2748 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2749 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002750 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002751 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002752 *
2753 * @see DocumentsContract
2754 */
2755 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002756 public static final String
2757 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002758
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002759 /** {@hide} */
2760 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2761
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002762 // ---------------------------------------------------------------------
2763 // ---------------------------------------------------------------------
2764 // Standard intent categories (see addCategory()).
2765
2766 /**
2767 * Set if the activity should be an option for the default action
2768 * (center press) to perform on a piece of data. Setting this will
2769 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002770 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002771 * Intent when initiating an action -- it is for use in intent filters
2772 * specified in packages.
2773 */
2774 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2775 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2776 /**
2777 * Activities that can be safely invoked from a browser must support this
2778 * category. For example, if the user is viewing a web page or an e-mail
2779 * and clicks on a link in the text, the Intent generated execute that
2780 * link will require the BROWSABLE category, so that only activities
2781 * supporting this category will be considered as possible actions. By
2782 * supporting this category, you are promising that there is nothing
2783 * damaging (without user intervention) that can happen by invoking any
2784 * matching Intent.
2785 */
2786 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2787 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2788 /**
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002789 * @hide
Dianne Hackborn91097de2014-04-04 18:02:06 -07002790 * Categories for activities that can participate in voice interaction.
2791 * An activity that supports this category must be prepared to run with
2792 * no UI shown at all (though in some case it may have a UI shown), and
2793 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2794 */
2795 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002796 @SystemApi
Dianne Hackborn91097de2014-04-04 18:02:06 -07002797 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2798 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002799 * Set if the activity should be considered as an alternative action to
2800 * the data the user is currently viewing. See also
2801 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2802 * applies to the selection in a list of items.
2803 *
2804 * <p>Supporting this category means that you would like your activity to be
2805 * displayed in the set of alternative things the user can do, usually as
2806 * part of the current activity's options menu. You will usually want to
2807 * include a specific label in the &lt;intent-filter&gt; of this action
2808 * describing to the user what it does.
2809 *
2810 * <p>The action of IntentFilter with this category is important in that it
2811 * describes the specific action the target will perform. This generally
2812 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2813 * a specific name such as "com.android.camera.action.CROP. Only one
2814 * alternative of any particular action will be shown to the user, so using
2815 * a specific action like this makes sure that your alternative will be
2816 * displayed while also allowing other applications to provide their own
2817 * overrides of that particular action.
2818 */
2819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2820 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2821 /**
2822 * Set if the activity should be considered as an alternative selection
2823 * action to the data the user has currently selected. This is like
2824 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2825 * of items from which the user can select, giving them alternatives to the
2826 * default action that will be performed on it.
2827 */
2828 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2829 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2830 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002831 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002832 */
2833 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2834 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2835 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002836 * Should be displayed in the top-level launcher.
2837 */
2838 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2839 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2840 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002841 * Indicates an activity optimized for Leanback mode, and that should
2842 * be displayed in the Leanback launcher.
2843 */
2844 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2845 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2846 /**
Jose Lima73915cf2014-07-29 17:16:31 -07002847 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
2848 * @hide
2849 */
2850 @SystemApi
2851 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
2852 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002853 * Provides information about the package it is in; typically used if
2854 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2855 * a front-door to the user without having to be shown in the all apps list.
2856 */
2857 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2858 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2859 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002860 * This is the home activity, that is the first activity that is displayed
2861 * when the device boots.
2862 */
2863 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2864 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2865 /**
2866 * This activity is a preference panel.
2867 */
2868 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2869 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2870 /**
2871 * This activity is a development preference panel.
2872 */
2873 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2874 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2875 /**
2876 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002877 */
2878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2879 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2880 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002881 * This activity allows the user to browse and download new applications.
2882 */
2883 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2884 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2885 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002886 * This activity may be exercised by the monkey or other automated test tools.
2887 */
2888 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2889 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2890 /**
2891 * To be used as a test (not part of the normal user experience).
2892 */
2893 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2894 /**
2895 * To be used as a unit test (run through the Test Harness).
2896 */
2897 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2898 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002899 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002900 * experience).
2901 */
2902 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002903
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002904 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002905 * Used to indicate that an intent only wants URIs that can be opened with
2906 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2907 * must support at least the columns defined in {@link OpenableColumns} when
2908 * queried.
2909 *
2910 * @see #ACTION_GET_CONTENT
2911 * @see #ACTION_OPEN_DOCUMENT
2912 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002913 */
2914 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2915 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2916
2917 /**
2918 * To be used as code under test for framework instrumentation tests.
2919 */
2920 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2921 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002922 /**
2923 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002924 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2925 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002926 */
2927 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2928 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2929 /**
2930 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002931 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2932 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002933 */
2934 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2935 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002936 /**
2937 * An activity to run when device is inserted into a analog (low end) dock.
2938 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2939 * information, see {@link android.app.UiModeManager}.
2940 */
2941 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2942 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2943
2944 /**
2945 * An activity to run when device is inserted into a digital (high end) dock.
2946 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2947 * information, see {@link android.app.UiModeManager}.
2948 */
2949 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2950 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002951
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002952 /**
2953 * Used to indicate that the activity can be used in a car environment.
2954 */
2955 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2956 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2957
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002958 // ---------------------------------------------------------------------
2959 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002960 // Application launch intent categories (see addCategory()).
2961
2962 /**
2963 * Used with {@link #ACTION_MAIN} to launch the browser application.
2964 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002965 * <p>NOTE: This should not be used as the primary key of an Intent,
2966 * since it will not result in the app launching with the correct
2967 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002968 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002969 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002970 */
2971 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2972 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2973
2974 /**
2975 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2976 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002977 * <p>NOTE: This should not be used as the primary key of an Intent,
2978 * since it will not result in the app launching with the correct
2979 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002980 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002981 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002982 */
2983 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2984 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2985
2986 /**
2987 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2988 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002989 * <p>NOTE: This should not be used as the primary key of an Intent,
2990 * since it will not result in the app launching with the correct
2991 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002992 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002993 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002994 */
2995 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2996 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2997
2998 /**
2999 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3000 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003001 * <p>NOTE: This should not be used as the primary key of an Intent,
3002 * since it will not result in the app launching with the correct
3003 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003004 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003005 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003006 */
3007 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3008 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3009
3010 /**
3011 * Used with {@link #ACTION_MAIN} to launch the email application.
3012 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003013 * <p>NOTE: This should not be used as the primary key of an Intent,
3014 * since it will not result in the app launching with the correct
3015 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003016 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003017 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003018 */
3019 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3020 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3021
3022 /**
3023 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3024 * The activity should be able to view and manipulate image and video files
3025 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003026 * <p>NOTE: This should not be used as the primary key of an Intent,
3027 * since it will not result in the app launching with the correct
3028 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003029 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003030 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003031 */
3032 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3033 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3034
3035 /**
3036 * Used with {@link #ACTION_MAIN} to launch the maps application.
3037 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003038 * <p>NOTE: This should not be used as the primary key of an Intent,
3039 * since it will not result in the app launching with the correct
3040 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003041 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003042 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003043 */
3044 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3045 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3046
3047 /**
3048 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3049 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003050 * <p>NOTE: This should not be used as the primary key of an Intent,
3051 * since it will not result in the app launching with the correct
3052 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003053 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003054 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003055 */
3056 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3057 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3058
3059 /**
3060 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003061 * The activity should be able to play, browse, or manipulate music files
3062 * stored on the device.
3063 * <p>NOTE: This should not be used as the primary key of an Intent,
3064 * since it will not result in the app launching with the correct
3065 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003066 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003067 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003068 */
3069 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3070 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3071
3072 // ---------------------------------------------------------------------
3073 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003074 // Standard extra data keys.
3075
3076 /**
3077 * The initial data to place in a newly created record. Use with
3078 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3079 * fields as would be given to the underlying ContentProvider.insert()
3080 * call.
3081 */
3082 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3083
3084 /**
3085 * A constant CharSequence that is associated with the Intent, used with
3086 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3087 * this may be a styled CharSequence, so you must use
3088 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3089 * retrieve it.
3090 */
3091 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3092
3093 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003094 * A constant String that is associated with the Intent, used with
3095 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3096 * as HTML formatted text. Note that you <em>must</em> also supply
3097 * {@link #EXTRA_TEXT}.
3098 */
3099 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3100
3101 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003102 * A content: URI holding a stream of data associated with the Intent,
3103 * used with {@link #ACTION_SEND} to supply the data being sent.
3104 */
3105 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3106
3107 /**
3108 * A String[] holding e-mail addresses that should be delivered to.
3109 */
3110 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3111
3112 /**
3113 * A String[] holding e-mail addresses that should be carbon copied.
3114 */
3115 public static final String EXTRA_CC = "android.intent.extra.CC";
3116
3117 /**
3118 * A String[] holding e-mail addresses that should be blind carbon copied.
3119 */
3120 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3121
3122 /**
3123 * A constant string holding the desired subject line of a message.
3124 */
3125 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3126
3127 /**
3128 * An Intent describing the choices you would like shown with
3129 * {@link #ACTION_PICK_ACTIVITY}.
3130 */
3131 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3132
3133 /**
3134 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003135 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003136 */
3137 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3138
3139 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003140 * A Parcelable[] of {@link Intent} or
3141 * {@link android.content.pm.LabeledIntent} objects as set with
3142 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3143 * a the front of the list of choices, when shown to the user with a
3144 * {@link #ACTION_CHOOSER}.
3145 */
3146 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3147
3148 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003149 * A Bundle forming a mapping of potential target package names to different extras Bundles
3150 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3151 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3152 * be currently installed on the device.
3153 *
3154 * <p>An application may choose to provide alternate extras for the case where a user
3155 * selects an activity from a predetermined set of target packages. If the activity
3156 * the user selects from the chooser belongs to a package with its package name as
3157 * a key in this bundle, the corresponding extras for that package will be merged with
3158 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3159 * extra has the same key as an extra already present in the intent it will overwrite
3160 * the extra from the intent.</p>
3161 *
3162 * <p><em>Examples:</em>
3163 * <ul>
3164 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3165 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3166 * parameters for that target.</li>
3167 * <li>An application may offer additional metadata for known targets of a given intent
3168 * to pass along information only relevant to that target such as account or content
3169 * identifiers already known to that application.</li>
3170 * </ul></p>
3171 */
3172 public static final String EXTRA_REPLACEMENT_EXTRAS =
3173 "android.intent.extra.REPLACEMENT_EXTRAS";
3174
3175 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003176 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3177 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3178 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3179 * {@link ComponentName} of the chosen component.
3180 *
3181 * <p>In some situations this callback may never come, for example if the user abandons
3182 * the chooser, switches to another task or any number of other reasons. Apps should not
3183 * be written assuming that this callback will always occur.</p>
3184 */
3185 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3186 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3187
3188 /**
3189 * The {@link ComponentName} chosen by the user to complete an action.
3190 *
3191 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3192 */
3193 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3194
3195 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003196 * A {@link android.view.KeyEvent} object containing the event that
3197 * triggered the creation of the Intent it is in.
3198 */
3199 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3200
3201 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003202 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3203 * before shutting down.
3204 *
3205 * {@hide}
3206 */
3207 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3208
3209 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003210 * 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 -07003211 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3212 * of restarting the application.
3213 */
3214 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3215
3216 /**
3217 * A String holding the phone number originally entered in
3218 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3219 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3220 */
3221 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003222
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003223 /**
3224 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3225 * intents to supply the uid the package had been assigned. Also an optional
3226 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3227 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3228 * purpose.
3229 */
3230 public static final String EXTRA_UID = "android.intent.extra.UID";
3231
3232 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003233 * @hide String array of package names.
3234 */
3235 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3236
3237 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003238 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3239 * intents to indicate whether this represents a full uninstall (removing
3240 * both the code and its data) or a partial uninstall (leaving its data,
3241 * implying that this is an update).
3242 */
3243 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003244
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003245 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003246 * @hide
3247 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3248 * intents to indicate that at this point the package has been removed for
3249 * all users on the device.
3250 */
3251 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3252 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3253
3254 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003255 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3256 * intents to indicate that this is a replacement of the package, so this
3257 * broadcast will immediately be followed by an add broadcast for a
3258 * different version of the same package.
3259 */
3260 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003261
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003262 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003263 * Used as an int extra field in {@link android.app.AlarmManager} intents
3264 * to tell the application being invoked how many pending alarms are being
3265 * delievered with the intent. For one-shot alarms this will always be 1.
3266 * For recurring alarms, this might be greater than 1 if the device was
3267 * asleep or powered off at the time an earlier alarm would have been
3268 * delivered.
3269 */
3270 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003271
Jacek Surazski86b6c532009-05-13 14:38:28 +02003272 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003273 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3274 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003275 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3276 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003277 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3278 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3279 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003280 */
3281 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3282
3283 /**
3284 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3285 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003286 */
3287 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3288
3289 /**
3290 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3291 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003292 */
3293 public static final int EXTRA_DOCK_STATE_DESK = 1;
3294
3295 /**
3296 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3297 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003298 */
3299 public static final int EXTRA_DOCK_STATE_CAR = 2;
3300
3301 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003302 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3303 * to represent that the phone is in a analog (low end) dock.
3304 */
3305 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3306
3307 /**
3308 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3309 * to represent that the phone is in a digital (high end) dock.
3310 */
3311 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3312
3313 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003314 * Boolean that can be supplied as meta-data with a dock activity, to
3315 * indicate that the dock should take over the home key when it is active.
3316 */
3317 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003318
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003319 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003320 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3321 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003322 */
3323 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3324
3325 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003326 * Used in the extra field in the remote intent. It's astring token passed with the
3327 * remote intent.
3328 */
3329 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3330 "android.intent.extra.remote_intent_token";
3331
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003332 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003333 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003334 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003335 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003336 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003337 "android.intent.extra.changed_component_name";
3338
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003339 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003340 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003341 * and contains a string array of all of the components that have changed. If
3342 * the state of the overall package has changed, then it will contain an entry
3343 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003344 */
3345 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3346 "android.intent.extra.changed_component_name_list";
3347
3348 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003349 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003350 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3351 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003352 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003353 */
3354 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3355 "android.intent.extra.changed_package_list";
3356
3357 /**
3358 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003359 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3360 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003361 * and contains an integer array of uids of all of the components
3362 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003363 */
3364 public static final String EXTRA_CHANGED_UID_LIST =
3365 "android.intent.extra.changed_uid_list";
3366
3367 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003368 * @hide
3369 * Magic extra system code can use when binding, to give a label for
3370 * who it is that has bound to a service. This is an integer giving
3371 * a framework string resource that can be displayed to the user.
3372 */
3373 public static final String EXTRA_CLIENT_LABEL =
3374 "android.intent.extra.client_label";
3375
3376 /**
3377 * @hide
3378 * Magic extra system code can use when binding, to give a PendingIntent object
3379 * that can be launched for the user to disable the system's use of this
3380 * service.
3381 */
3382 public static final String EXTRA_CLIENT_INTENT =
3383 "android.intent.extra.client_intent";
3384
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003385 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003386 * Extra used to indicate that an intent should only return data that is on
3387 * the local device. This is a boolean extra; the default is false. If true,
3388 * an implementation should only allow the user to select data that is
3389 * already on the device, not requiring it be downloaded from a remote
3390 * service when opened.
3391 *
3392 * @see #ACTION_GET_CONTENT
3393 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003394 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003395 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003396 */
3397 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003398 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003399
Amith Yamasani13593602012-03-22 16:16:17 -07003400 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003401 * Extra used to indicate that an intent can allow the user to select and
3402 * return multiple items. This is a boolean extra; the default is false. If
3403 * true, an implementation is allowed to present the user with a UI where
3404 * they can pick multiple items that are all returned to the caller. When
3405 * this happens, they should be returned as the {@link #getClipData()} part
3406 * of the result Intent.
3407 *
3408 * @see #ACTION_GET_CONTENT
3409 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003410 */
3411 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003412 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003413
3414 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003415 * The integer userHandle carried with broadcast intents related to addition, removal and
3416 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3417 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3418 *
Amith Yamasani13593602012-03-22 16:16:17 -07003419 * @hide
3420 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003421 public static final String EXTRA_USER_HANDLE =
3422 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003423
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003424 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003425 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3426 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3427 */
3428 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003429 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003430
3431 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003432 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003433 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3434 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003435 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003436 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3437
3438 /**
3439 * Extra sent in the intent to the BroadcastReceiver that handles
3440 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3441 * the restrictions as key/value pairs.
3442 */
3443 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3444 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003445
Amith Yamasani86118ba2013-03-28 14:33:16 -07003446 /**
3447 * Extra used in the response from a BroadcastReceiver that handles
3448 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3449 */
3450 public static final String EXTRA_RESTRICTIONS_INTENT =
3451 "android.intent.extra.restrictions_intent";
3452
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003453 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003454 * Extra used to communicate a set of acceptable MIME types. The type of the
3455 * extra is {@code String[]}. Values may be a combination of concrete MIME
3456 * types (such as "image/png") and/or partial MIME types (such as
3457 * "audio/*").
3458 *
3459 * @see #ACTION_GET_CONTENT
3460 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003461 */
3462 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3463
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003464 /**
3465 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3466 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003467 * When this is true, hardware devices can use this information to determine that
3468 * they shouldn't do a complete shutdown of their device since this is not a
3469 * complete shutdown down to the kernel, but only user space restarting.
3470 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003471 */
3472 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3473 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3474
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003475 /**
3476 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3477 * user has set their time format preferences to the 24 hour format.
3478 *
3479 * @hide for internal use only.
3480 */
3481 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3482 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3483
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003484 /** {@hide} */
3485 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3486
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003487 // ---------------------------------------------------------------------
3488 // ---------------------------------------------------------------------
3489 // Intent flags (see mFlags variable).
3490
Tor Norbyed9273d62013-05-30 15:59:53 -07003491 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003492 @IntDef(flag = true, value = {
3493 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3494 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003495 @Retention(RetentionPolicy.SOURCE)
3496 public @interface GrantUriMode {}
3497
Jeff Sharkey846318a2014-04-04 12:12:41 -07003498 /** @hide */
3499 @IntDef(flag = true, value = {
3500 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3501 @Retention(RetentionPolicy.SOURCE)
3502 public @interface AccessUriMode {}
3503
3504 /**
3505 * Test if given mode flags specify an access mode, which must be at least
3506 * read and/or write.
3507 *
3508 * @hide
3509 */
3510 public static boolean isAccessUriMode(int modeFlags) {
3511 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3512 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3513 }
3514
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003515 /**
3516 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003517 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003518 * specified in its ClipData. When applying to an Intent's ClipData,
3519 * all URIs as well as recursive traversals through data or other ClipData
3520 * in Intent items will be granted; only the grant flags of the top-level
3521 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003522 */
3523 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3524 /**
3525 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003526 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003527 * specified in its ClipData. When applying to an Intent's ClipData,
3528 * all URIs as well as recursive traversals through data or other ClipData
3529 * in Intent items will be granted; only the grant flags of the top-level
3530 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003531 */
3532 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3533 /**
3534 * Can be set by the caller to indicate that this Intent is coming from
3535 * a background operation, not from direct user interaction.
3536 */
3537 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3538 /**
3539 * A flag you can enable for debugging: when set, log messages will be
3540 * printed during the resolution of this intent to show you what has
3541 * been found to create the final resolved list.
3542 */
3543 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003544 /**
3545 * If set, this intent will not match any components in packages that
3546 * are currently stopped. If this is not set, then the default behavior
3547 * is to include such applications in the result.
3548 */
3549 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3550 /**
3551 * If set, this intent will always match any components in packages that
3552 * are currently stopped. This is the default behavior when
3553 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3554 * flags are set, this one wins (it allows overriding of exclude for
3555 * places where the framework may automatically set the exclude flag).
3556 */
3557 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003558
3559 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003560 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003561 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003562 * persisted across device reboots until explicitly revoked with
3563 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3564 * grant for possible persisting; the receiving application must call
3565 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3566 * actually persist.
3567 *
3568 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3569 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3570 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003571 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003572 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003573 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003574
3575 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003576 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3577 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3578 * applies to any URI that is a prefix match against the original granted
3579 * URI. (Without this flag, the URI must match exactly for access to be
3580 * granted.) Another URI is considered a prefix match only when scheme,
3581 * authority, and all path segments defined by the prefix are an exact
3582 * match.
3583 */
3584 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3585
3586 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003587 * If set, the new activity is not kept in the history stack. As soon as
3588 * the user navigates away from it, the activity is finished. This may also
3589 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3590 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003591 */
3592 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3593 /**
3594 * If set, the activity will not be launched if it is already running
3595 * at the top of the history stack.
3596 */
3597 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3598 /**
3599 * If set, this activity will become the start of a new task on this
3600 * history stack. A task (from the activity that started it to the
3601 * next task activity) defines an atomic group of activities that the
3602 * user can move to. Tasks can be moved to the foreground and background;
3603 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003604 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003605 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3606 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003607 *
3608 * <p>This flag is generally used by activities that want
3609 * to present a "launcher" style behavior: they give the user a list of
3610 * separate things that can be done, which otherwise run completely
3611 * independently of the activity launching them.
3612 *
3613 * <p>When using this flag, if a task is already running for the activity
3614 * you are now starting, then a new activity will not be started; instead,
3615 * the current task will simply be brought to the front of the screen with
3616 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3617 * to disable this behavior.
3618 *
3619 * <p>This flag can not be used when the caller is requesting a result from
3620 * the activity being launched.
3621 */
3622 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3623 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003624 * This flag is used to create a new task and launch an activity into it.
3625 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3626 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3627 * search through existing tasks for ones matching this Intent. Only if no such
3628 * task is found would a new task be created. When paired with
3629 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3630 * the search for a matching task and unconditionally start a new task.
3631 *
3632 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3633 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 * top-level application launcher.</strong> Used in conjunction with
3635 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3636 * behavior of bringing an existing task to the foreground. When set,
3637 * a new task is <em>always</em> started to host the Activity for the
3638 * Intent, regardless of whether there is already an existing task running
3639 * the same thing.
3640 *
3641 * <p><strong>Because the default system does not include graphical task management,
3642 * you should not use this flag unless you provide some way for a user to
3643 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003644 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003645 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3646 * creating new document tasks.
3647 *
3648 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003649 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003650 *
Scott Main7aee61f2011-02-08 11:25:01 -08003651 * <p>See
3652 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3653 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003654 *
3655 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3656 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003657 */
3658 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3659 /**
3660 * If set, and the activity being launched is already running in the
3661 * current task, then instead of launching a new instance of that activity,
3662 * all of the other activities on top of it will be closed and this Intent
3663 * will be delivered to the (now on top) old activity as a new Intent.
3664 *
3665 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3666 * If D calls startActivity() with an Intent that resolves to the component
3667 * of activity B, then C and D will be finished and B receive the given
3668 * Intent, resulting in the stack now being: A, B.
3669 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003670 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003671 * either receive the new intent you are starting here in its
3672 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003673 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003674 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3675 * the same intent, then it will be finished and re-created; for all other
3676 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3677 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003678 *
3679 * <p>This launch mode can also be used to good effect in conjunction with
3680 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3681 * of a task, it will bring any currently running instance of that task
3682 * to the foreground, and then clear it to its root state. This is
3683 * especially useful, for example, when launching an activity from the
3684 * notification manager.
3685 *
Scott Main7aee61f2011-02-08 11:25:01 -08003686 * <p>See
3687 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3688 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003689 */
3690 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3691 /**
3692 * If set and this intent is being used to launch a new activity from an
3693 * existing one, then the reply target of the existing activity will be
3694 * transfered to the new activity. This way the new activity can call
3695 * {@link android.app.Activity#setResult} and have that result sent back to
3696 * the reply target of the original activity.
3697 */
3698 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3699 /**
3700 * If set and this intent is being used to launch a new activity from an
3701 * existing one, the current activity will not be counted as the top
3702 * activity for deciding whether the new intent should be delivered to
3703 * the top instead of starting a new one. The previous activity will
3704 * be used as the top, with the assumption being that the current activity
3705 * will finish itself immediately.
3706 */
3707 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3708 /**
3709 * If set, the new activity is not kept in the list of recently launched
3710 * activities.
3711 */
3712 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3713 /**
3714 * This flag is not normally set by application code, but set for you by
3715 * the system as described in the
3716 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3717 * launchMode} documentation for the singleTask mode.
3718 */
3719 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3720 /**
3721 * If set, and this activity is either being started in a new task or
3722 * bringing to the top an existing task, then it will be launched as
3723 * the front door of the task. This will result in the application of
3724 * any affinities needed to have that task in the proper state (either
3725 * moving activities to or from it), or simply resetting that task to
3726 * its initial state if needed.
3727 */
3728 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3729 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003730 * This flag is not normally set by application code, but set for you by
3731 * the system if this activity is being launched from history
3732 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003733 */
3734 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003735 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003736 * @deprecated As of API 21 this performs identically to
3737 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003738 */
3739 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003740 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003741 * This flag is used to open a document into a new task rooted at the activity launched
3742 * by this Intent. Through the use of this flag, or its equivalent attribute,
3743 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3744 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003745 *
Craig Mautner026596b2014-05-21 15:35:44 -07003746 * <p>The use of the activity attribute form of this,
3747 * {@link android.R.attr#documentLaunchMode}, is
3748 * preferred over the Intent flag described here. The attribute form allows the
3749 * Activity to specify multiple document behavior for all launchers of the Activity
3750 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003751 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003752 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3753 * it is kept after the activity is finished is different than the use of
3754 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3755 * this flag is being used to create a new recents entry, then by default that entry
3756 * will be removed once the activity is finished. You can modify this behavior with
3757 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3758 *
Craig Mautner026596b2014-05-21 15:35:44 -07003759 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3760 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3761 * equivalent of the Activity manifest specifying {@link
3762 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3763 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3764 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003765 *
Craig Mautner026596b2014-05-21 15:35:44 -07003766 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003767 *
Craig Mautner026596b2014-05-21 15:35:44 -07003768 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003769 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3770 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003771 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003772 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003773 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003774 * callback from occurring on the current frontmost activity before it is
3775 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003776 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003777 * <p>Typically, an activity can rely on that callback to indicate that an
3778 * explicit user action has caused their activity to be moved out of the
3779 * foreground. The callback marks an appropriate point in the activity's
3780 * lifecycle for it to dismiss any notifications that it intends to display
3781 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003782 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003783 * <p>If an activity is ever started via any non-user-driven events such as
3784 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3785 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003786 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003787 */
3788 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003789 /**
3790 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3791 * this flag will cause the launched activity to be brought to the front of its
3792 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003793 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003794 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3795 * If D calls startActivity() with an Intent that resolves to the component
3796 * of activity B, then B will be brought to the front of the history stack,
3797 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003798 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003799 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003800 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003801 */
3802 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003803 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003804 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3805 * this flag will prevent the system from applying an activity transition
3806 * animation to go to the next activity state. This doesn't mean an
3807 * animation will never run -- if another activity change happens that doesn't
3808 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003809 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003810 * when you are going to do a series of activity operations but the
3811 * animation seen by the user shouldn't be driven by the first activity
3812 * change but rather a later one.
3813 */
3814 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3815 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003816 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3817 * this flag will cause any existing task that would be associated with the
3818 * activity to be cleared before the activity is started. That is, the activity
3819 * becomes the new root of an otherwise empty task, and any old activities
3820 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3821 */
3822 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3823 /**
3824 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3825 * this flag will cause a newly launching task to be placed on top of the current
3826 * home activity task (if there is one). That is, pressing back from the task
3827 * will always return the user to home even if that was not the last activity they
3828 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3829 */
3830 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3831 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003832 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3833 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003834 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003835 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003836 * this flag. When set and the task's activity is finished, the recents
3837 * entry will remain in the interface for the user to re-launch it, like a
3838 * recents entry for a top-level application.
3839 * <p>
3840 * The receiving activity can override this request with
3841 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
3842 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07003843 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07003844 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07003845 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07003846
3847 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003848 * If set, when sending a broadcast only registered receivers will be
3849 * called -- no BroadcastReceiver components will be launched.
3850 */
3851 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003852 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003853 * If set, when sending a broadcast the new broadcast will replace
3854 * any existing pending broadcast that matches it. Matching is defined
3855 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3856 * true for the intents of the two broadcasts. When a match is found,
3857 * the new broadcast (and receivers associated with it) will replace the
3858 * existing one in the pending broadcast list, remaining at the same
3859 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003860 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003861 * <p>This flag is most typically used with sticky broadcasts, which
3862 * only care about delivering the most recent values of the broadcast
3863 * to their receivers.
3864 */
3865 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3866 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003867 * If set, when sending a broadcast the recipient is allowed to run at
3868 * foreground priority, with a shorter timeout interval. During normal
3869 * broadcasts the receivers are not automatically hoisted out of the
3870 * background priority class.
3871 */
3872 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3873 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003874 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3875 * They can still propagate results through to later receivers, but they can not prevent
3876 * later receivers from seeing the broadcast.
3877 */
3878 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3879 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003880 * If set, when sending a broadcast <i>before boot has completed</i> only
3881 * registered receivers will be called -- no BroadcastReceiver components
3882 * will be launched. Sticky intent state will be recorded properly even
3883 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3884 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003885 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003886 * <p>This flag is only for use by system sevices as a convenience to
3887 * avoid having to implement a more complex mechanism around detection
3888 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003889 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003890 * @hide
3891 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003892 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003893 /**
3894 * Set when this broadcast is for a boot upgrade, a special mode that
3895 * allows the broadcast to be sent before the system is ready and launches
3896 * the app process with no providers running in it.
3897 * @hide
3898 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003899 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003900
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003901 /**
3902 * @hide Flags that can't be changed with PendingIntent.
3903 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003904 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3905 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3906 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003907
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003908 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003909 // ---------------------------------------------------------------------
3910 // toUri() and parseUri() options.
3911
3912 /**
3913 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3914 * always has the "intent:" scheme. This syntax can be used when you want
3915 * to later disambiguate between URIs that are intended to describe an
3916 * Intent vs. all others that should be treated as raw URIs. When used
3917 * with {@link #parseUri}, any other scheme will result in a generic
3918 * VIEW action for that raw URI.
3919 */
3920 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003921
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003922 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003923
3924 private String mAction;
3925 private Uri mData;
3926 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003927 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003928 private ComponentName mComponent;
3929 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003930 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003931 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003932 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003933 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003934 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003935 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003936
3937 // ---------------------------------------------------------------------
3938
3939 /**
3940 * Create an empty intent.
3941 */
3942 public Intent() {
3943 }
3944
3945 /**
3946 * Copy constructor.
3947 */
3948 public Intent(Intent o) {
3949 this.mAction = o.mAction;
3950 this.mData = o.mData;
3951 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003952 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 this.mComponent = o.mComponent;
3954 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003955 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003956 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003957 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003958 }
3959 if (o.mExtras != null) {
3960 this.mExtras = new Bundle(o.mExtras);
3961 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003962 if (o.mSourceBounds != null) {
3963 this.mSourceBounds = new Rect(o.mSourceBounds);
3964 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003965 if (o.mSelector != null) {
3966 this.mSelector = new Intent(o.mSelector);
3967 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003968 if (o.mClipData != null) {
3969 this.mClipData = new ClipData(o.mClipData);
3970 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003971 }
3972
3973 @Override
3974 public Object clone() {
3975 return new Intent(this);
3976 }
3977
3978 private Intent(Intent o, boolean all) {
3979 this.mAction = o.mAction;
3980 this.mData = o.mData;
3981 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003982 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003983 this.mComponent = o.mComponent;
3984 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003985 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003986 }
3987 }
3988
3989 /**
3990 * Make a clone of only the parts of the Intent that are relevant for
3991 * filter matching: the action, data, type, component, and categories.
3992 */
3993 public Intent cloneFilter() {
3994 return new Intent(this, false);
3995 }
3996
3997 /**
3998 * Create an intent with a given action. All other fields (data, type,
3999 * class) are null. Note that the action <em>must</em> be in a
4000 * namespace because Intents are used globally in the system -- for
4001 * example the system VIEW action is android.intent.action.VIEW; an
4002 * application's custom action would be something like
4003 * com.google.app.myapp.CUSTOM_ACTION.
4004 *
4005 * @param action The Intent action, such as ACTION_VIEW.
4006 */
4007 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004008 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004009 }
4010
4011 /**
4012 * Create an intent with a given action and for a given data url. Note
4013 * that the action <em>must</em> be in a namespace because Intents are
4014 * used globally in the system -- for example the system VIEW action is
4015 * android.intent.action.VIEW; an application's custom action would be
4016 * something like com.google.app.myapp.CUSTOM_ACTION.
4017 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004018 * <p><em>Note: scheme and host name matching in the Android framework is
4019 * case-sensitive, unlike the formal RFC. As a result,
4020 * you should always ensure that you write your Uri with these elements
4021 * using lower case letters, and normalize any Uris you receive from
4022 * outside of Android to ensure the scheme and host is lower case.</em></p>
4023 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004024 * @param action The Intent action, such as ACTION_VIEW.
4025 * @param uri The Intent data URI.
4026 */
4027 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004028 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004029 mData = uri;
4030 }
4031
4032 /**
4033 * Create an intent for a specific component. All other fields (action, data,
4034 * type, class) are null, though they can be modified later with explicit
4035 * calls. This provides a convenient way to create an intent that is
4036 * intended to execute a hard-coded class name, rather than relying on the
4037 * system to find an appropriate class for you; see {@link #setComponent}
4038 * for more information on the repercussions of this.
4039 *
4040 * @param packageContext A Context of the application package implementing
4041 * this class.
4042 * @param cls The component class that is to be used for the intent.
4043 *
4044 * @see #setClass
4045 * @see #setComponent
4046 * @see #Intent(String, android.net.Uri , Context, Class)
4047 */
4048 public Intent(Context packageContext, Class<?> cls) {
4049 mComponent = new ComponentName(packageContext, cls);
4050 }
4051
4052 /**
4053 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004054 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004055 * construct the Intent and then calling {@link #setClass} to set its
4056 * class.
4057 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004058 * <p><em>Note: scheme and host name matching in the Android framework is
4059 * case-sensitive, unlike the formal RFC. As a result,
4060 * you should always ensure that you write your Uri with these elements
4061 * using lower case letters, and normalize any Uris you receive from
4062 * outside of Android to ensure the scheme and host is lower case.</em></p>
4063 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004064 * @param action The Intent action, such as ACTION_VIEW.
4065 * @param uri The Intent data URI.
4066 * @param packageContext A Context of the application package implementing
4067 * this class.
4068 * @param cls The component class that is to be used for the intent.
4069 *
4070 * @see #Intent(String, android.net.Uri)
4071 * @see #Intent(Context, Class)
4072 * @see #setClass
4073 * @see #setComponent
4074 */
4075 public Intent(String action, Uri uri,
4076 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004077 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004078 mData = uri;
4079 mComponent = new ComponentName(packageContext, cls);
4080 }
4081
4082 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004083 * Create an intent to launch the main (root) activity of a task. This
4084 * is the Intent that is started when the application's is launched from
4085 * Home. For anything else that wants to launch an application in the
4086 * same way, it is important that they use an Intent structured the same
4087 * way, and can use this function to ensure this is the case.
4088 *
4089 * <p>The returned Intent has the given Activity component as its explicit
4090 * component, {@link #ACTION_MAIN} as its action, and includes the
4091 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4092 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4093 * to do that through {@link #addFlags(int)} on the returned Intent.
4094 *
4095 * @param mainActivity The main activity component that this Intent will
4096 * launch.
4097 * @return Returns a newly created Intent that can be used to launch the
4098 * activity as a main application entry.
4099 *
4100 * @see #setClass
4101 * @see #setComponent
4102 */
4103 public static Intent makeMainActivity(ComponentName mainActivity) {
4104 Intent intent = new Intent(ACTION_MAIN);
4105 intent.setComponent(mainActivity);
4106 intent.addCategory(CATEGORY_LAUNCHER);
4107 return intent;
4108 }
4109
4110 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004111 * Make an Intent for the main activity of an application, without
4112 * specifying a specific activity to run but giving a selector to find
4113 * the activity. This results in a final Intent that is structured
4114 * the same as when the application is launched from
4115 * Home. For anything else that wants to launch an application in the
4116 * same way, it is important that they use an Intent structured the same
4117 * way, and can use this function to ensure this is the case.
4118 *
4119 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4120 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4121 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4122 * to do that through {@link #addFlags(int)} on the returned Intent.
4123 *
4124 * @param selectorAction The action name of the Intent's selector.
4125 * @param selectorCategory The name of a category to add to the Intent's
4126 * selector.
4127 * @return Returns a newly created Intent that can be used to launch the
4128 * activity as a main application entry.
4129 *
4130 * @see #setSelector(Intent)
4131 */
4132 public static Intent makeMainSelectorActivity(String selectorAction,
4133 String selectorCategory) {
4134 Intent intent = new Intent(ACTION_MAIN);
4135 intent.addCategory(CATEGORY_LAUNCHER);
4136 Intent selector = new Intent();
4137 selector.setAction(selectorAction);
4138 selector.addCategory(selectorCategory);
4139 intent.setSelector(selector);
4140 return intent;
4141 }
4142
4143 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004144 * Make an Intent that can be used to re-launch an application's task
4145 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4146 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4147 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4148 *
4149 * @param mainActivity The activity component that is the root of the
4150 * task; this is the activity that has been published in the application's
4151 * manifest as the main launcher icon.
4152 *
4153 * @return Returns a newly created Intent that can be used to relaunch the
4154 * activity's task in its root state.
4155 */
4156 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4157 Intent intent = makeMainActivity(mainActivity);
4158 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4159 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4160 return intent;
4161 }
4162
4163 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004164 * Call {@link #parseUri} with 0 flags.
4165 * @deprecated Use {@link #parseUri} instead.
4166 */
4167 @Deprecated
4168 public static Intent getIntent(String uri) throws URISyntaxException {
4169 return parseUri(uri, 0);
4170 }
Tom Taylord4a47292009-12-21 13:59:18 -08004171
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004172 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004173 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004174 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004175 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004176 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004177 *
4178 * <p>The URI given here must not be relative -- that is, it must include
4179 * the scheme and full path.
4180 *
4181 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004182 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004183 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004184 *
4185 * @return Intent The newly created Intent object.
4186 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004187 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4188 * it bad (as parsed by the Uri class) or the Intent data within the
4189 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004190 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004191 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004192 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004193 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004194 int i = 0;
4195 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004196 // Validate intent scheme for if requested.
4197 if ((flags&URI_INTENT_SCHEME) != 0) {
4198 if (!uri.startsWith("intent:")) {
4199 Intent intent = new Intent(ACTION_VIEW);
4200 try {
4201 intent.setData(Uri.parse(uri));
4202 } catch (IllegalArgumentException e) {
4203 throw new URISyntaxException(uri, e.getMessage());
4204 }
4205 return intent;
4206 }
4207 }
Tom Taylord4a47292009-12-21 13:59:18 -08004208
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004209 // simple case
4210 i = uri.lastIndexOf("#");
4211 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4212
4213 // old format Intent URI
4214 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004215
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004216 // new format
4217 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004218 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004219
4220 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004221 String data = i >= 0 ? uri.substring(0, i) : null;
4222 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004223 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004224
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004225 // loop over contents of Intent, all name=value;
4226 while (!uri.startsWith("end", i)) {
4227 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004228 if (eq < 0) eq = i-1;
4229 int semi = uri.indexOf(';', i);
4230 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004231
4232 // action
4233 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004234 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004235 }
4236
4237 // categories
4238 else if (uri.startsWith("category=", i)) {
4239 intent.addCategory(value);
4240 }
4241
4242 // type
4243 else if (uri.startsWith("type=", i)) {
4244 intent.mType = value;
4245 }
4246
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004247 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004248 else if (uri.startsWith("launchFlags=", i)) {
4249 intent.mFlags = Integer.decode(value).intValue();
4250 }
4251
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004252 // package
4253 else if (uri.startsWith("package=", i)) {
4254 intent.mPackage = value;
4255 }
4256
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004257 // component
4258 else if (uri.startsWith("component=", i)) {
4259 intent.mComponent = ComponentName.unflattenFromString(value);
4260 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004261
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004262 // scheme
4263 else if (uri.startsWith("scheme=", i)) {
4264 scheme = value;
4265 }
4266
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004267 // source bounds
4268 else if (uri.startsWith("sourceBounds=", i)) {
4269 intent.mSourceBounds = Rect.unflattenFromString(value);
4270 }
4271
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004272 // selector
4273 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4274 intent = new Intent();
4275 }
4276
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277 // extra
4278 else {
4279 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004280 // create Bundle if it doesn't already exist
4281 if (intent.mExtras == null) intent.mExtras = new Bundle();
4282 Bundle b = intent.mExtras;
4283 // add EXTRA
4284 if (uri.startsWith("S.", i)) b.putString(key, value);
4285 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4286 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4287 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4288 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4289 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4290 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4291 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4292 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4293 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4294 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004295
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004296 // move to the next item
4297 i = semi + 1;
4298 }
4299
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004300 if (intent != baseIntent) {
4301 // The Intent had a selector; fix it up.
4302 baseIntent.setSelector(intent);
4303 intent = baseIntent;
4304 }
4305
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004306 if (data != null) {
4307 if (data.startsWith("intent:")) {
4308 data = data.substring(7);
4309 if (scheme != null) {
4310 data = scheme + ':' + data;
4311 }
4312 }
Tom Taylord4a47292009-12-21 13:59:18 -08004313
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004314 if (data.length() > 0) {
4315 try {
4316 intent.mData = Uri.parse(data);
4317 } catch (IllegalArgumentException e) {
4318 throw new URISyntaxException(uri, e.getMessage());
4319 }
4320 }
4321 }
Tom Taylord4a47292009-12-21 13:59:18 -08004322
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004323 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004324
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004325 } catch (IndexOutOfBoundsException e) {
4326 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4327 }
4328 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004329
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004330 public static Intent getIntentOld(String uri) throws URISyntaxException {
4331 Intent intent;
4332
4333 int i = uri.lastIndexOf('#');
4334 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004335 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004336 final int intentFragmentStart = i;
4337 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004338
4339 i++;
4340
4341 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004342 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004343 i += 7;
4344 int j = uri.indexOf(')', i);
4345 action = uri.substring(i, j);
4346 i = j + 1;
4347 }
4348
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004349 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004350
4351 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004352 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004353 i += 11;
4354 int j = uri.indexOf(')', i);
4355 while (i < j) {
4356 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004357 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004358 if (i < sep) {
4359 intent.addCategory(uri.substring(i, sep));
4360 }
4361 i = sep + 1;
4362 }
4363 i = j + 1;
4364 }
4365
4366 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004367 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004368 i += 5;
4369 int j = uri.indexOf(')', i);
4370 intent.mType = uri.substring(i, j);
4371 i = j + 1;
4372 }
4373
4374 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004375 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004376 i += 12;
4377 int j = uri.indexOf(')', i);
4378 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4379 i = j + 1;
4380 }
4381
4382 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004383 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004384 i += 10;
4385 int j = uri.indexOf(')', i);
4386 int sep = uri.indexOf('!', i);
4387 if (sep >= 0 && sep < j) {
4388 String pkg = uri.substring(i, sep);
4389 String cls = uri.substring(sep + 1, j);
4390 intent.mComponent = new ComponentName(pkg, cls);
4391 }
4392 i = j + 1;
4393 }
4394
4395 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004396 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004397 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004398
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004399 final int closeParen = uri.indexOf(')', i);
4400 if (closeParen == -1) throw new URISyntaxException(uri,
4401 "EXTRA missing trailing ')'", i);
4402
4403 while (i < closeParen) {
4404 // fetch the key value
4405 int j = uri.indexOf('=', i);
4406 if (j <= i + 1 || i >= closeParen) {
4407 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4408 }
4409 char type = uri.charAt(i);
4410 i++;
4411 String key = uri.substring(i, j);
4412 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004413
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004414 // get type-value
4415 j = uri.indexOf('!', i);
4416 if (j == -1 || j >= closeParen) j = closeParen;
4417 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4418 String value = uri.substring(i, j);
4419 i = j;
4420
4421 // create Bundle if it doesn't already exist
4422 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004423
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004424 // add item to bundle
4425 try {
4426 switch (type) {
4427 case 'S':
4428 intent.mExtras.putString(key, Uri.decode(value));
4429 break;
4430 case 'B':
4431 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4432 break;
4433 case 'b':
4434 intent.mExtras.putByte(key, Byte.parseByte(value));
4435 break;
4436 case 'c':
4437 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4438 break;
4439 case 'd':
4440 intent.mExtras.putDouble(key, Double.parseDouble(value));
4441 break;
4442 case 'f':
4443 intent.mExtras.putFloat(key, Float.parseFloat(value));
4444 break;
4445 case 'i':
4446 intent.mExtras.putInt(key, Integer.parseInt(value));
4447 break;
4448 case 'l':
4449 intent.mExtras.putLong(key, Long.parseLong(value));
4450 break;
4451 case 's':
4452 intent.mExtras.putShort(key, Short.parseShort(value));
4453 break;
4454 default:
4455 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4456 }
4457 } catch (NumberFormatException e) {
4458 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4459 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004460
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004461 char ch = uri.charAt(i);
4462 if (ch == ')') break;
4463 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4464 i++;
4465 }
4466 }
4467
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004468 if (isIntentFragment) {
4469 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4470 } else {
4471 intent.mData = Uri.parse(uri);
4472 }
Tom Taylord4a47292009-12-21 13:59:18 -08004473
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004474 if (intent.mAction == null) {
4475 // By default, if no action is specified, then use VIEW.
4476 intent.mAction = ACTION_VIEW;
4477 }
4478
4479 } else {
4480 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4481 }
4482
4483 return intent;
4484 }
4485
4486 /**
4487 * Retrieve the general action to be performed, such as
4488 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4489 * the information in the intent should be interpreted -- most importantly,
4490 * what to do with the data returned by {@link #getData}.
4491 *
4492 * @return The action of this intent or null if none is specified.
4493 *
4494 * @see #setAction
4495 */
4496 public String getAction() {
4497 return mAction;
4498 }
4499
4500 /**
4501 * Retrieve data this intent is operating on. This URI specifies the name
4502 * of the data; often it uses the content: scheme, specifying data in a
4503 * content provider. Other schemes may be handled by specific activities,
4504 * such as http: by the web browser.
4505 *
4506 * @return The URI of the data this intent is targeting or null.
4507 *
4508 * @see #getScheme
4509 * @see #setData
4510 */
4511 public Uri getData() {
4512 return mData;
4513 }
4514
4515 /**
4516 * The same as {@link #getData()}, but returns the URI as an encoded
4517 * String.
4518 */
4519 public String getDataString() {
4520 return mData != null ? mData.toString() : null;
4521 }
4522
4523 /**
4524 * Return the scheme portion of the intent's data. If the data is null or
4525 * does not include a scheme, null is returned. Otherwise, the scheme
4526 * prefix without the final ':' is returned, i.e. "http".
4527 *
4528 * <p>This is the same as calling getData().getScheme() (and checking for
4529 * null data).
4530 *
4531 * @return The scheme of this intent.
4532 *
4533 * @see #getData
4534 */
4535 public String getScheme() {
4536 return mData != null ? mData.getScheme() : null;
4537 }
4538
4539 /**
4540 * Retrieve any explicit MIME type included in the intent. This is usually
4541 * null, as the type is determined by the intent data.
4542 *
4543 * @return If a type was manually set, it is returned; else null is
4544 * returned.
4545 *
4546 * @see #resolveType(ContentResolver)
4547 * @see #setType
4548 */
4549 public String getType() {
4550 return mType;
4551 }
4552
4553 /**
4554 * Return the MIME data type of this intent. If the type field is
4555 * explicitly set, that is simply returned. Otherwise, if the data is set,
4556 * the type of that data is returned. If neither fields are set, a null is
4557 * returned.
4558 *
4559 * @return The MIME type of this intent.
4560 *
4561 * @see #getType
4562 * @see #resolveType(ContentResolver)
4563 */
4564 public String resolveType(Context context) {
4565 return resolveType(context.getContentResolver());
4566 }
4567
4568 /**
4569 * Return the MIME data type of this intent. If the type field is
4570 * explicitly set, that is simply returned. Otherwise, if the data is set,
4571 * the type of that data is returned. If neither fields are set, a null is
4572 * returned.
4573 *
4574 * @param resolver A ContentResolver that can be used to determine the MIME
4575 * type of the intent's data.
4576 *
4577 * @return The MIME type of this intent.
4578 *
4579 * @see #getType
4580 * @see #resolveType(Context)
4581 */
4582 public String resolveType(ContentResolver resolver) {
4583 if (mType != null) {
4584 return mType;
4585 }
4586 if (mData != null) {
4587 if ("content".equals(mData.getScheme())) {
4588 return resolver.getType(mData);
4589 }
4590 }
4591 return null;
4592 }
4593
4594 /**
4595 * Return the MIME data type of this intent, only if it will be needed for
4596 * intent resolution. This is not generally useful for application code;
4597 * it is used by the frameworks for communicating with back-end system
4598 * services.
4599 *
4600 * @param resolver A ContentResolver that can be used to determine the MIME
4601 * type of the intent's data.
4602 *
4603 * @return The MIME type of this intent, or null if it is unknown or not
4604 * needed.
4605 */
4606 public String resolveTypeIfNeeded(ContentResolver resolver) {
4607 if (mComponent != null) {
4608 return mType;
4609 }
4610 return resolveType(resolver);
4611 }
4612
4613 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004614 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004615 *
4616 * @param category The category to check.
4617 *
4618 * @return boolean True if the intent contains the category, else false.
4619 *
4620 * @see #getCategories
4621 * @see #addCategory
4622 */
4623 public boolean hasCategory(String category) {
4624 return mCategories != null && mCategories.contains(category);
4625 }
4626
4627 /**
4628 * Return the set of all categories in the intent. If there are no categories,
4629 * returns NULL.
4630 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004631 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004632 *
4633 * @see #hasCategory
4634 * @see #addCategory
4635 */
4636 public Set<String> getCategories() {
4637 return mCategories;
4638 }
4639
4640 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004641 * Return the specific selector associated with this Intent. If there is
4642 * none, returns null. See {@link #setSelector} for more information.
4643 *
4644 * @see #setSelector
4645 */
4646 public Intent getSelector() {
4647 return mSelector;
4648 }
4649
4650 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004651 * Return the {@link ClipData} associated with this Intent. If there is
4652 * none, returns null. See {@link #setClipData} for more information.
4653 *
John Spurlock125d1332013-11-25 11:58:37 -05004654 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004655 */
4656 public ClipData getClipData() {
4657 return mClipData;
4658 }
4659
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004660 /** @hide */
4661 public int getContentUserHint() {
4662 return mContentUserHint;
4663 }
4664
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004665 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004666 * Sets the ClassLoader that will be used when unmarshalling
4667 * any Parcelable values from the extras of this Intent.
4668 *
4669 * @param loader a ClassLoader, or null to use the default loader
4670 * at the time of unmarshalling.
4671 */
4672 public void setExtrasClassLoader(ClassLoader loader) {
4673 if (mExtras != null) {
4674 mExtras.setClassLoader(loader);
4675 }
4676 }
4677
4678 /**
4679 * Returns true if an extra value is associated with the given name.
4680 * @param name the extra's name
4681 * @return true if the given extra is present.
4682 */
4683 public boolean hasExtra(String name) {
4684 return mExtras != null && mExtras.containsKey(name);
4685 }
4686
4687 /**
4688 * Returns true if the Intent's extras contain a parcelled file descriptor.
4689 * @return true if the Intent contains a parcelled file descriptor.
4690 */
4691 public boolean hasFileDescriptors() {
4692 return mExtras != null && mExtras.hasFileDescriptors();
4693 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004694
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004695 /** @hide */
4696 public void setAllowFds(boolean allowFds) {
4697 if (mExtras != null) {
4698 mExtras.setAllowFds(allowFds);
4699 }
4700 }
4701
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004702 /**
4703 * Retrieve extended data from the intent.
4704 *
4705 * @param name The name of the desired item.
4706 *
4707 * @return the value of an item that previously added with putExtra()
4708 * or null if none was found.
4709 *
4710 * @deprecated
4711 * @hide
4712 */
4713 @Deprecated
4714 public Object getExtra(String name) {
4715 return getExtra(name, null);
4716 }
4717
4718 /**
4719 * Retrieve extended data from the intent.
4720 *
4721 * @param name The name of the desired item.
4722 * @param defaultValue the value to be returned if no value of the desired
4723 * type is stored with the given name.
4724 *
4725 * @return the value of an item that previously added with putExtra()
4726 * or the default value if none was found.
4727 *
4728 * @see #putExtra(String, boolean)
4729 */
4730 public boolean getBooleanExtra(String name, boolean defaultValue) {
4731 return mExtras == null ? defaultValue :
4732 mExtras.getBoolean(name, defaultValue);
4733 }
4734
4735 /**
4736 * Retrieve extended data from the intent.
4737 *
4738 * @param name The name of the desired item.
4739 * @param defaultValue the value to be returned if no value of the desired
4740 * type is stored with the given name.
4741 *
4742 * @return the value of an item that previously added with putExtra()
4743 * or the default value if none was found.
4744 *
4745 * @see #putExtra(String, byte)
4746 */
4747 public byte getByteExtra(String name, byte defaultValue) {
4748 return mExtras == null ? defaultValue :
4749 mExtras.getByte(name, defaultValue);
4750 }
4751
4752 /**
4753 * Retrieve extended data from the intent.
4754 *
4755 * @param name The name of the desired item.
4756 * @param defaultValue the value to be returned if no value of the desired
4757 * type is stored with the given name.
4758 *
4759 * @return the value of an item that previously added with putExtra()
4760 * or the default value if none was found.
4761 *
4762 * @see #putExtra(String, short)
4763 */
4764 public short getShortExtra(String name, short defaultValue) {
4765 return mExtras == null ? defaultValue :
4766 mExtras.getShort(name, defaultValue);
4767 }
4768
4769 /**
4770 * Retrieve extended data from the intent.
4771 *
4772 * @param name The name of the desired item.
4773 * @param defaultValue the value to be returned if no value of the desired
4774 * type is stored with the given name.
4775 *
4776 * @return the value of an item that previously added with putExtra()
4777 * or the default value if none was found.
4778 *
4779 * @see #putExtra(String, char)
4780 */
4781 public char getCharExtra(String name, char defaultValue) {
4782 return mExtras == null ? defaultValue :
4783 mExtras.getChar(name, defaultValue);
4784 }
4785
4786 /**
4787 * Retrieve extended data from the intent.
4788 *
4789 * @param name The name of the desired item.
4790 * @param defaultValue the value to be returned if no value of the desired
4791 * type is stored with the given name.
4792 *
4793 * @return the value of an item that previously added with putExtra()
4794 * or the default value if none was found.
4795 *
4796 * @see #putExtra(String, int)
4797 */
4798 public int getIntExtra(String name, int defaultValue) {
4799 return mExtras == null ? defaultValue :
4800 mExtras.getInt(name, defaultValue);
4801 }
4802
4803 /**
4804 * Retrieve extended data from the intent.
4805 *
4806 * @param name The name of the desired item.
4807 * @param defaultValue the value to be returned if no value of the desired
4808 * type is stored with the given name.
4809 *
4810 * @return the value of an item that previously added with putExtra()
4811 * or the default value if none was found.
4812 *
4813 * @see #putExtra(String, long)
4814 */
4815 public long getLongExtra(String name, long defaultValue) {
4816 return mExtras == null ? defaultValue :
4817 mExtras.getLong(name, defaultValue);
4818 }
4819
4820 /**
4821 * Retrieve extended data from the intent.
4822 *
4823 * @param name The name of the desired item.
4824 * @param defaultValue the value to be returned if no value of the desired
4825 * type is stored with the given name.
4826 *
4827 * @return the value of an item that previously added with putExtra(),
4828 * or the default value if no such item is present
4829 *
4830 * @see #putExtra(String, float)
4831 */
4832 public float getFloatExtra(String name, float defaultValue) {
4833 return mExtras == null ? defaultValue :
4834 mExtras.getFloat(name, defaultValue);
4835 }
4836
4837 /**
4838 * Retrieve extended data from the intent.
4839 *
4840 * @param name The name of the desired item.
4841 * @param defaultValue the value to be returned if no value of the desired
4842 * type is stored with the given name.
4843 *
4844 * @return the value of an item that previously added with putExtra()
4845 * or the default value if none was found.
4846 *
4847 * @see #putExtra(String, double)
4848 */
4849 public double getDoubleExtra(String name, double defaultValue) {
4850 return mExtras == null ? defaultValue :
4851 mExtras.getDouble(name, defaultValue);
4852 }
4853
4854 /**
4855 * Retrieve extended data from the intent.
4856 *
4857 * @param name The name of the desired item.
4858 *
4859 * @return the value of an item that previously added with putExtra()
4860 * or null if no String value was found.
4861 *
4862 * @see #putExtra(String, String)
4863 */
4864 public String getStringExtra(String name) {
4865 return mExtras == null ? null : mExtras.getString(name);
4866 }
4867
4868 /**
4869 * Retrieve extended data from the intent.
4870 *
4871 * @param name The name of the desired item.
4872 *
4873 * @return the value of an item that previously added with putExtra()
4874 * or null if no CharSequence value was found.
4875 *
4876 * @see #putExtra(String, CharSequence)
4877 */
4878 public CharSequence getCharSequenceExtra(String name) {
4879 return mExtras == null ? null : mExtras.getCharSequence(name);
4880 }
4881
4882 /**
4883 * Retrieve extended data from the intent.
4884 *
4885 * @param name The name of the desired item.
4886 *
4887 * @return the value of an item that previously added with putExtra()
4888 * or null if no Parcelable value was found.
4889 *
4890 * @see #putExtra(String, Parcelable)
4891 */
4892 public <T extends Parcelable> T getParcelableExtra(String name) {
4893 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4894 }
4895
4896 /**
4897 * Retrieve extended data from the intent.
4898 *
4899 * @param name The name of the desired item.
4900 *
4901 * @return the value of an item that previously added with putExtra()
4902 * or null if no Parcelable[] value was found.
4903 *
4904 * @see #putExtra(String, Parcelable[])
4905 */
4906 public Parcelable[] getParcelableArrayExtra(String name) {
4907 return mExtras == null ? null : mExtras.getParcelableArray(name);
4908 }
4909
4910 /**
4911 * Retrieve extended data from the intent.
4912 *
4913 * @param name The name of the desired item.
4914 *
4915 * @return the value of an item that previously added with putExtra()
4916 * or null if no ArrayList<Parcelable> value was found.
4917 *
4918 * @see #putParcelableArrayListExtra(String, ArrayList)
4919 */
4920 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4921 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4922 }
4923
4924 /**
4925 * Retrieve extended data from the intent.
4926 *
4927 * @param name The name of the desired item.
4928 *
4929 * @return the value of an item that previously added with putExtra()
4930 * or null if no Serializable value was found.
4931 *
4932 * @see #putExtra(String, Serializable)
4933 */
4934 public Serializable getSerializableExtra(String name) {
4935 return mExtras == null ? null : mExtras.getSerializable(name);
4936 }
4937
4938 /**
4939 * Retrieve extended data from the intent.
4940 *
4941 * @param name The name of the desired item.
4942 *
4943 * @return the value of an item that previously added with putExtra()
4944 * or null if no ArrayList<Integer> value was found.
4945 *
4946 * @see #putIntegerArrayListExtra(String, ArrayList)
4947 */
4948 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4949 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4950 }
4951
4952 /**
4953 * Retrieve extended data from the intent.
4954 *
4955 * @param name The name of the desired item.
4956 *
4957 * @return the value of an item that previously added with putExtra()
4958 * or null if no ArrayList<String> value was found.
4959 *
4960 * @see #putStringArrayListExtra(String, ArrayList)
4961 */
4962 public ArrayList<String> getStringArrayListExtra(String name) {
4963 return mExtras == null ? null : mExtras.getStringArrayList(name);
4964 }
4965
4966 /**
4967 * Retrieve extended data from the intent.
4968 *
4969 * @param name The name of the desired item.
4970 *
4971 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004972 * or null if no ArrayList<CharSequence> value was found.
4973 *
4974 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4975 */
4976 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4977 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4978 }
4979
4980 /**
4981 * Retrieve extended data from the intent.
4982 *
4983 * @param name The name of the desired item.
4984 *
4985 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004986 * or null if no boolean array value was found.
4987 *
4988 * @see #putExtra(String, boolean[])
4989 */
4990 public boolean[] getBooleanArrayExtra(String name) {
4991 return mExtras == null ? null : mExtras.getBooleanArray(name);
4992 }
4993
4994 /**
4995 * Retrieve extended data from the intent.
4996 *
4997 * @param name The name of the desired item.
4998 *
4999 * @return the value of an item that previously added with putExtra()
5000 * or null if no byte array value was found.
5001 *
5002 * @see #putExtra(String, byte[])
5003 */
5004 public byte[] getByteArrayExtra(String name) {
5005 return mExtras == null ? null : mExtras.getByteArray(name);
5006 }
5007
5008 /**
5009 * Retrieve extended data from the intent.
5010 *
5011 * @param name The name of the desired item.
5012 *
5013 * @return the value of an item that previously added with putExtra()
5014 * or null if no short array value was found.
5015 *
5016 * @see #putExtra(String, short[])
5017 */
5018 public short[] getShortArrayExtra(String name) {
5019 return mExtras == null ? null : mExtras.getShortArray(name);
5020 }
5021
5022 /**
5023 * Retrieve extended data from the intent.
5024 *
5025 * @param name The name of the desired item.
5026 *
5027 * @return the value of an item that previously added with putExtra()
5028 * or null if no char array value was found.
5029 *
5030 * @see #putExtra(String, char[])
5031 */
5032 public char[] getCharArrayExtra(String name) {
5033 return mExtras == null ? null : mExtras.getCharArray(name);
5034 }
5035
5036 /**
5037 * Retrieve extended data from the intent.
5038 *
5039 * @param name The name of the desired item.
5040 *
5041 * @return the value of an item that previously added with putExtra()
5042 * or null if no int array value was found.
5043 *
5044 * @see #putExtra(String, int[])
5045 */
5046 public int[] getIntArrayExtra(String name) {
5047 return mExtras == null ? null : mExtras.getIntArray(name);
5048 }
5049
5050 /**
5051 * Retrieve extended data from the intent.
5052 *
5053 * @param name The name of the desired item.
5054 *
5055 * @return the value of an item that previously added with putExtra()
5056 * or null if no long array value was found.
5057 *
5058 * @see #putExtra(String, long[])
5059 */
5060 public long[] getLongArrayExtra(String name) {
5061 return mExtras == null ? null : mExtras.getLongArray(name);
5062 }
5063
5064 /**
5065 * Retrieve extended data from the intent.
5066 *
5067 * @param name The name of the desired item.
5068 *
5069 * @return the value of an item that previously added with putExtra()
5070 * or null if no float array value was found.
5071 *
5072 * @see #putExtra(String, float[])
5073 */
5074 public float[] getFloatArrayExtra(String name) {
5075 return mExtras == null ? null : mExtras.getFloatArray(name);
5076 }
5077
5078 /**
5079 * Retrieve extended data from the intent.
5080 *
5081 * @param name The name of the desired item.
5082 *
5083 * @return the value of an item that previously added with putExtra()
5084 * or null if no double array value was found.
5085 *
5086 * @see #putExtra(String, double[])
5087 */
5088 public double[] getDoubleArrayExtra(String name) {
5089 return mExtras == null ? null : mExtras.getDoubleArray(name);
5090 }
5091
5092 /**
5093 * Retrieve extended data from the intent.
5094 *
5095 * @param name The name of the desired item.
5096 *
5097 * @return the value of an item that previously added with putExtra()
5098 * or null if no String array value was found.
5099 *
5100 * @see #putExtra(String, String[])
5101 */
5102 public String[] getStringArrayExtra(String name) {
5103 return mExtras == null ? null : mExtras.getStringArray(name);
5104 }
5105
5106 /**
5107 * Retrieve extended data from the intent.
5108 *
5109 * @param name The name of the desired item.
5110 *
5111 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005112 * or null if no CharSequence array value was found.
5113 *
5114 * @see #putExtra(String, CharSequence[])
5115 */
5116 public CharSequence[] getCharSequenceArrayExtra(String name) {
5117 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5118 }
5119
5120 /**
5121 * Retrieve extended data from the intent.
5122 *
5123 * @param name The name of the desired item.
5124 *
5125 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005126 * or null if no Bundle value was found.
5127 *
5128 * @see #putExtra(String, Bundle)
5129 */
5130 public Bundle getBundleExtra(String name) {
5131 return mExtras == null ? null : mExtras.getBundle(name);
5132 }
5133
5134 /**
5135 * Retrieve extended data from the intent.
5136 *
5137 * @param name The name of the desired item.
5138 *
5139 * @return the value of an item that previously added with putExtra()
5140 * or null if no IBinder value was found.
5141 *
5142 * @see #putExtra(String, IBinder)
5143 *
5144 * @deprecated
5145 * @hide
5146 */
5147 @Deprecated
5148 public IBinder getIBinderExtra(String name) {
5149 return mExtras == null ? null : mExtras.getIBinder(name);
5150 }
5151
5152 /**
5153 * Retrieve extended data from the intent.
5154 *
5155 * @param name The name of the desired item.
5156 * @param defaultValue The default value to return in case no item is
5157 * associated with the key 'name'
5158 *
5159 * @return the value of an item that previously added with putExtra()
5160 * or defaultValue if none was found.
5161 *
5162 * @see #putExtra
5163 *
5164 * @deprecated
5165 * @hide
5166 */
5167 @Deprecated
5168 public Object getExtra(String name, Object defaultValue) {
5169 Object result = defaultValue;
5170 if (mExtras != null) {
5171 Object result2 = mExtras.get(name);
5172 if (result2 != null) {
5173 result = result2;
5174 }
5175 }
5176
5177 return result;
5178 }
5179
5180 /**
5181 * Retrieves a map of extended data from the intent.
5182 *
5183 * @return the map of all extras previously added with putExtra(),
5184 * or null if none have been added.
5185 */
5186 public Bundle getExtras() {
5187 return (mExtras != null)
5188 ? new Bundle(mExtras)
5189 : null;
5190 }
5191
5192 /**
5193 * Retrieve any special flags associated with this intent. You will
5194 * normally just set them with {@link #setFlags} and let the system
5195 * take the appropriate action with them.
5196 *
5197 * @return int The currently set flags.
5198 *
5199 * @see #setFlags
5200 */
5201 public int getFlags() {
5202 return mFlags;
5203 }
5204
Dianne Hackborne7f97212011-02-24 14:40:20 -08005205 /** @hide */
5206 public boolean isExcludingStopped() {
5207 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5208 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5209 }
5210
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005211 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005212 * Retrieve the application package name this Intent is limited to. When
5213 * resolving an Intent, if non-null this limits the resolution to only
5214 * components in the given application package.
5215 *
5216 * @return The name of the application package for the Intent.
5217 *
5218 * @see #resolveActivity
5219 * @see #setPackage
5220 */
5221 public String getPackage() {
5222 return mPackage;
5223 }
5224
5225 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005226 * Retrieve the concrete component associated with the intent. When receiving
5227 * an intent, this is the component that was found to best handle it (that is,
5228 * yourself) and will always be non-null; in all other cases it will be
5229 * null unless explicitly set.
5230 *
5231 * @return The name of the application component to handle the intent.
5232 *
5233 * @see #resolveActivity
5234 * @see #setComponent
5235 */
5236 public ComponentName getComponent() {
5237 return mComponent;
5238 }
5239
5240 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005241 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5242 * used as a hint to the receiver for animations and the like. Null means that there
5243 * is no source bounds.
5244 */
5245 public Rect getSourceBounds() {
5246 return mSourceBounds;
5247 }
5248
5249 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005250 * Return the Activity component that should be used to handle this intent.
5251 * The appropriate component is determined based on the information in the
5252 * intent, evaluated as follows:
5253 *
5254 * <p>If {@link #getComponent} returns an explicit class, that is returned
5255 * without any further consideration.
5256 *
5257 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5258 * category to be considered.
5259 *
5260 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5261 * action.
5262 *
5263 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5264 * this type.
5265 *
5266 * <p>If {@link #addCategory} has added any categories, the activity must
5267 * handle ALL of the categories specified.
5268 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005269 * <p>If {@link #getPackage} is non-NULL, only activity components in
5270 * that application package will be considered.
5271 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005272 * <p>If there are no activities that satisfy all of these conditions, a
5273 * null string is returned.
5274 *
5275 * <p>If multiple activities are found to satisfy the intent, the one with
5276 * the highest priority will be used. If there are multiple activities
5277 * with the same priority, the system will either pick the best activity
5278 * based on user preference, or resolve to a system class that will allow
5279 * the user to pick an activity and forward from there.
5280 *
5281 * <p>This method is implemented simply by calling
5282 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5283 * true.</p>
5284 * <p> This API is called for you as part of starting an activity from an
5285 * intent. You do not normally need to call it yourself.</p>
5286 *
5287 * @param pm The package manager with which to resolve the Intent.
5288 *
5289 * @return Name of the component implementing an activity that can
5290 * display the intent.
5291 *
5292 * @see #setComponent
5293 * @see #getComponent
5294 * @see #resolveActivityInfo
5295 */
5296 public ComponentName resolveActivity(PackageManager pm) {
5297 if (mComponent != null) {
5298 return mComponent;
5299 }
5300
5301 ResolveInfo info = pm.resolveActivity(
5302 this, PackageManager.MATCH_DEFAULT_ONLY);
5303 if (info != null) {
5304 return new ComponentName(
5305 info.activityInfo.applicationInfo.packageName,
5306 info.activityInfo.name);
5307 }
5308
5309 return null;
5310 }
5311
5312 /**
5313 * Resolve the Intent into an {@link ActivityInfo}
5314 * describing the activity that should execute the intent. Resolution
5315 * follows the same rules as described for {@link #resolveActivity}, but
5316 * you get back the completely information about the resolved activity
5317 * instead of just its class name.
5318 *
5319 * @param pm The package manager with which to resolve the Intent.
5320 * @param flags Addition information to retrieve as per
5321 * {@link PackageManager#getActivityInfo(ComponentName, int)
5322 * PackageManager.getActivityInfo()}.
5323 *
5324 * @return PackageManager.ActivityInfo
5325 *
5326 * @see #resolveActivity
5327 */
5328 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5329 ActivityInfo ai = null;
5330 if (mComponent != null) {
5331 try {
5332 ai = pm.getActivityInfo(mComponent, flags);
5333 } catch (PackageManager.NameNotFoundException e) {
5334 // ignore
5335 }
5336 } else {
5337 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005338 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005339 if (info != null) {
5340 ai = info.activityInfo;
5341 }
5342 }
5343
5344 return ai;
5345 }
5346
5347 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005348 * Special function for use by the system to resolve service
5349 * intents to system apps. Throws an exception if there are
5350 * multiple potential matches to the Intent. Returns null if
5351 * there are no matches.
5352 * @hide
5353 */
5354 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5355 if (mComponent != null) {
5356 return mComponent;
5357 }
5358
5359 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5360 if (results == null) {
5361 return null;
5362 }
5363 ComponentName comp = null;
5364 for (int i=0; i<results.size(); i++) {
5365 ResolveInfo ri = results.get(i);
5366 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5367 continue;
5368 }
5369 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5370 ri.serviceInfo.name);
5371 if (comp != null) {
5372 throw new IllegalStateException("Multiple system services handle " + this
5373 + ": " + comp + ", " + foundComp);
5374 }
5375 comp = foundComp;
5376 }
5377 return comp;
5378 }
5379
5380 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005381 * Set the general action to be performed.
5382 *
5383 * @param action An action name, such as ACTION_VIEW. Application-specific
5384 * actions should be prefixed with the vendor's package name.
5385 *
5386 * @return Returns the same Intent object, for chaining multiple calls
5387 * into a single statement.
5388 *
5389 * @see #getAction
5390 */
5391 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005392 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005393 return this;
5394 }
5395
5396 /**
5397 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005398 * clears any type that was previously set by {@link #setType} or
5399 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005400 *
Nick Pellyccae4122012-01-09 14:12:58 -08005401 * <p><em>Note: scheme matching in the Android framework is
5402 * case-sensitive, unlike the formal RFC. As a result,
5403 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005404 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005405 * {@link #setDataAndNormalize}
5406 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005407 *
Nick Pellyccae4122012-01-09 14:12:58 -08005408 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005409 *
5410 * @return Returns the same Intent object, for chaining multiple calls
5411 * into a single statement.
5412 *
5413 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005414 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005415 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005416 */
5417 public Intent setData(Uri data) {
5418 mData = data;
5419 mType = null;
5420 return this;
5421 }
5422
5423 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005424 * Normalize and set the data this intent is operating on.
5425 *
5426 * <p>This method automatically clears any type that was
5427 * previously set (for example, by {@link #setType}).
5428 *
5429 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005430 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005431 * so really this is just a convenience method for
5432 * <pre>
5433 * setData(data.normalize())
5434 * </pre>
5435 *
5436 * @param data The Uri of the data this intent is now targeting.
5437 *
5438 * @return Returns the same Intent object, for chaining multiple calls
5439 * into a single statement.
5440 *
5441 * @see #getData
5442 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005443 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005444 */
5445 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005446 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005447 }
5448
5449 /**
5450 * Set an explicit MIME data type.
5451 *
5452 * <p>This is used to create intents that only specify a type and not data,
5453 * for example to indicate the type of data to return.
5454 *
5455 * <p>This method automatically clears any data that was
5456 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005457 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005458 * <p><em>Note: MIME type matching in the Android framework is
5459 * case-sensitive, unlike formal RFC MIME types. As a result,
5460 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005461 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5462 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005463 *
5464 * @param type The MIME type of the data being handled by this intent.
5465 *
5466 * @return Returns the same Intent object, for chaining multiple calls
5467 * into a single statement.
5468 *
5469 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005470 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005471 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005472 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005473 */
5474 public Intent setType(String type) {
5475 mData = null;
5476 mType = type;
5477 return this;
5478 }
5479
5480 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005481 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005482 *
Nick Pellyccae4122012-01-09 14:12:58 -08005483 * <p>This is used to create intents that only specify a type and not data,
5484 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005485 *
Nick Pellyccae4122012-01-09 14:12:58 -08005486 * <p>This method automatically clears any data that was
5487 * previously set (for example by {@link #setData}).
5488 *
5489 * <p>The MIME type is normalized using
5490 * {@link #normalizeMimeType} before it is set,
5491 * so really this is just a convenience method for
5492 * <pre>
5493 * setType(Intent.normalizeMimeType(type))
5494 * </pre>
5495 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005496 * @param type The MIME type of the data being handled by this intent.
5497 *
5498 * @return Returns the same Intent object, for chaining multiple calls
5499 * into a single statement.
5500 *
Nick Pellyccae4122012-01-09 14:12:58 -08005501 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005502 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005503 * @see #normalizeMimeType
5504 */
5505 public Intent setTypeAndNormalize(String type) {
5506 return setType(normalizeMimeType(type));
5507 }
5508
5509 /**
5510 * (Usually optional) Set the data for the intent along with an explicit
5511 * MIME data type. This method should very rarely be used -- it allows you
5512 * to override the MIME type that would ordinarily be inferred from the
5513 * data with your own type given here.
5514 *
5515 * <p><em>Note: MIME type and Uri scheme matching in the
5516 * Android framework is case-sensitive, unlike the formal RFC definitions.
5517 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005518 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005519 * {@link #setDataAndTypeAndNormalize}
5520 * to ensure that they are converted to lower case.</em>
5521 *
5522 * @param data The Uri of the data this intent is now targeting.
5523 * @param type The MIME type of the data being handled by this intent.
5524 *
5525 * @return Returns the same Intent object, for chaining multiple calls
5526 * into a single statement.
5527 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005528 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005529 * @see #setData
5530 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005531 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005532 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005533 */
5534 public Intent setDataAndType(Uri data, String type) {
5535 mData = data;
5536 mType = type;
5537 return this;
5538 }
5539
5540 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005541 * (Usually optional) Normalize and set both the data Uri and an explicit
5542 * MIME data type. This method should very rarely be used -- it allows you
5543 * to override the MIME type that would ordinarily be inferred from the
5544 * data with your own type given here.
5545 *
5546 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005547 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005548 * before they are set, so really this is just a convenience method for
5549 * <pre>
5550 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5551 * </pre>
5552 *
5553 * @param data The Uri of the data this intent is now targeting.
5554 * @param type The MIME type of the data being handled by this intent.
5555 *
5556 * @return Returns the same Intent object, for chaining multiple calls
5557 * into a single statement.
5558 *
5559 * @see #setType
5560 * @see #setData
5561 * @see #setDataAndType
5562 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005563 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005564 */
5565 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005566 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005567 }
5568
5569 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005570 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005571 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005572 * activities that provide <em>all</em> of the requested categories will be
5573 * used.
5574 *
5575 * @param category The desired category. This can be either one of the
5576 * predefined Intent categories, or a custom category in your own
5577 * namespace.
5578 *
5579 * @return Returns the same Intent object, for chaining multiple calls
5580 * into a single statement.
5581 *
5582 * @see #hasCategory
5583 * @see #removeCategory
5584 */
5585 public Intent addCategory(String category) {
5586 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005587 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005588 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005589 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005590 return this;
5591 }
5592
5593 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005594 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005595 *
5596 * @param category The category to remove.
5597 *
5598 * @see #addCategory
5599 */
5600 public void removeCategory(String category) {
5601 if (mCategories != null) {
5602 mCategories.remove(category);
5603 if (mCategories.size() == 0) {
5604 mCategories = null;
5605 }
5606 }
5607 }
5608
5609 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005610 * Set a selector for this Intent. This is a modification to the kinds of
5611 * things the Intent will match. If the selector is set, it will be used
5612 * when trying to find entities that can handle the Intent, instead of the
5613 * main contents of the Intent. This allows you build an Intent containing
5614 * a generic protocol while targeting it more specifically.
5615 *
5616 * <p>An example of where this may be used is with things like
5617 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5618 * Intent that will launch the Browser application. However, the correct
5619 * main entry point of an application is actually {@link #ACTION_MAIN}
5620 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5621 * used to specify the actual Activity to launch. If you launch the browser
5622 * with something different, undesired behavior may happen if the user has
5623 * previously or later launches it the normal way, since they do not match.
5624 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5625 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5626 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5627 *
5628 * <p>Setting a selector does not impact the behavior of
5629 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5630 * desired behavior of a selector -- it does not impact the base meaning
5631 * of the Intent, just what kinds of things will be matched against it
5632 * when determining who can handle it.</p>
5633 *
5634 * <p>You can not use both a selector and {@link #setPackage(String)} on
5635 * the same base Intent.</p>
5636 *
5637 * @param selector The desired selector Intent; set to null to not use
5638 * a special selector.
5639 */
5640 public void setSelector(Intent selector) {
5641 if (selector == this) {
5642 throw new IllegalArgumentException(
5643 "Intent being set as a selector of itself");
5644 }
5645 if (selector != null && mPackage != null) {
5646 throw new IllegalArgumentException(
5647 "Can't set selector when package name is already set");
5648 }
5649 mSelector = selector;
5650 }
5651
5652 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005653 * Set a {@link ClipData} associated with this Intent. This replaces any
5654 * previously set ClipData.
5655 *
5656 * <p>The ClipData in an intent is not used for Intent matching or other
5657 * such operations. Semantically it is like extras, used to transmit
5658 * additional data with the Intent. The main feature of using this over
5659 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5660 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5661 * items included in the clip data. This is useful, in particular, if
5662 * you want to transmit an Intent containing multiple <code>content:</code>
5663 * URIs for which the recipient may not have global permission to access the
5664 * content provider.
5665 *
5666 * <p>If the ClipData contains items that are themselves Intents, any
5667 * grant flags in those Intents will be ignored. Only the top-level flags
5668 * of the main Intent are respected, and will be applied to all Uri or
5669 * Intent items in the clip (or sub-items of the clip).
5670 *
5671 * <p>The MIME type, label, and icon in the ClipData object are not
5672 * directly used by Intent. Applications should generally rely on the
5673 * MIME type of the Intent itself, not what it may find in the ClipData.
5674 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005675 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005676 *
5677 * @param clip The new clip to set. May be null to clear the current clip.
5678 */
5679 public void setClipData(ClipData clip) {
5680 mClipData = clip;
5681 }
5682
5683 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005684 * This is NOT a secure mechanism to identify the user who sent the intent.
5685 * When the intent is sent to a different user, it is used to fix uris by adding the userId
5686 * who sent the intent.
5687 * @hide
5688 */
5689 public void setContentUserHint(int contentUserHint) {
5690 mContentUserHint = contentUserHint;
5691 }
5692
5693 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005694 * Add extended data to the intent. The name must include a package
5695 * prefix, for example the app com.android.contacts would use names
5696 * like "com.android.contacts.ShowAll".
5697 *
5698 * @param name The name of the extra data, with package prefix.
5699 * @param value The boolean data value.
5700 *
5701 * @return Returns the same Intent object, for chaining multiple calls
5702 * into a single statement.
5703 *
5704 * @see #putExtras
5705 * @see #removeExtra
5706 * @see #getBooleanExtra(String, boolean)
5707 */
5708 public Intent putExtra(String name, boolean value) {
5709 if (mExtras == null) {
5710 mExtras = new Bundle();
5711 }
5712 mExtras.putBoolean(name, value);
5713 return this;
5714 }
5715
5716 /**
5717 * Add extended data to the intent. The name must include a package
5718 * prefix, for example the app com.android.contacts would use names
5719 * like "com.android.contacts.ShowAll".
5720 *
5721 * @param name The name of the extra data, with package prefix.
5722 * @param value The byte data value.
5723 *
5724 * @return Returns the same Intent object, for chaining multiple calls
5725 * into a single statement.
5726 *
5727 * @see #putExtras
5728 * @see #removeExtra
5729 * @see #getByteExtra(String, byte)
5730 */
5731 public Intent putExtra(String name, byte value) {
5732 if (mExtras == null) {
5733 mExtras = new Bundle();
5734 }
5735 mExtras.putByte(name, value);
5736 return this;
5737 }
5738
5739 /**
5740 * Add extended data to the intent. The name must include a package
5741 * prefix, for example the app com.android.contacts would use names
5742 * like "com.android.contacts.ShowAll".
5743 *
5744 * @param name The name of the extra data, with package prefix.
5745 * @param value The char data value.
5746 *
5747 * @return Returns the same Intent object, for chaining multiple calls
5748 * into a single statement.
5749 *
5750 * @see #putExtras
5751 * @see #removeExtra
5752 * @see #getCharExtra(String, char)
5753 */
5754 public Intent putExtra(String name, char value) {
5755 if (mExtras == null) {
5756 mExtras = new Bundle();
5757 }
5758 mExtras.putChar(name, value);
5759 return this;
5760 }
5761
5762 /**
5763 * Add extended data to the intent. The name must include a package
5764 * prefix, for example the app com.android.contacts would use names
5765 * like "com.android.contacts.ShowAll".
5766 *
5767 * @param name The name of the extra data, with package prefix.
5768 * @param value The short data value.
5769 *
5770 * @return Returns the same Intent object, for chaining multiple calls
5771 * into a single statement.
5772 *
5773 * @see #putExtras
5774 * @see #removeExtra
5775 * @see #getShortExtra(String, short)
5776 */
5777 public Intent putExtra(String name, short value) {
5778 if (mExtras == null) {
5779 mExtras = new Bundle();
5780 }
5781 mExtras.putShort(name, value);
5782 return this;
5783 }
5784
5785 /**
5786 * Add extended data to the intent. The name must include a package
5787 * prefix, for example the app com.android.contacts would use names
5788 * like "com.android.contacts.ShowAll".
5789 *
5790 * @param name The name of the extra data, with package prefix.
5791 * @param value The integer data value.
5792 *
5793 * @return Returns the same Intent object, for chaining multiple calls
5794 * into a single statement.
5795 *
5796 * @see #putExtras
5797 * @see #removeExtra
5798 * @see #getIntExtra(String, int)
5799 */
5800 public Intent putExtra(String name, int value) {
5801 if (mExtras == null) {
5802 mExtras = new Bundle();
5803 }
5804 mExtras.putInt(name, value);
5805 return this;
5806 }
5807
5808 /**
5809 * Add extended data to the intent. The name must include a package
5810 * prefix, for example the app com.android.contacts would use names
5811 * like "com.android.contacts.ShowAll".
5812 *
5813 * @param name The name of the extra data, with package prefix.
5814 * @param value The long data value.
5815 *
5816 * @return Returns the same Intent object, for chaining multiple calls
5817 * into a single statement.
5818 *
5819 * @see #putExtras
5820 * @see #removeExtra
5821 * @see #getLongExtra(String, long)
5822 */
5823 public Intent putExtra(String name, long value) {
5824 if (mExtras == null) {
5825 mExtras = new Bundle();
5826 }
5827 mExtras.putLong(name, value);
5828 return this;
5829 }
5830
5831 /**
5832 * Add extended data to the intent. The name must include a package
5833 * prefix, for example the app com.android.contacts would use names
5834 * like "com.android.contacts.ShowAll".
5835 *
5836 * @param name The name of the extra data, with package prefix.
5837 * @param value The float data value.
5838 *
5839 * @return Returns the same Intent object, for chaining multiple calls
5840 * into a single statement.
5841 *
5842 * @see #putExtras
5843 * @see #removeExtra
5844 * @see #getFloatExtra(String, float)
5845 */
5846 public Intent putExtra(String name, float value) {
5847 if (mExtras == null) {
5848 mExtras = new Bundle();
5849 }
5850 mExtras.putFloat(name, value);
5851 return this;
5852 }
5853
5854 /**
5855 * Add extended data to the intent. The name must include a package
5856 * prefix, for example the app com.android.contacts would use names
5857 * like "com.android.contacts.ShowAll".
5858 *
5859 * @param name The name of the extra data, with package prefix.
5860 * @param value The double data value.
5861 *
5862 * @return Returns the same Intent object, for chaining multiple calls
5863 * into a single statement.
5864 *
5865 * @see #putExtras
5866 * @see #removeExtra
5867 * @see #getDoubleExtra(String, double)
5868 */
5869 public Intent putExtra(String name, double value) {
5870 if (mExtras == null) {
5871 mExtras = new Bundle();
5872 }
5873 mExtras.putDouble(name, value);
5874 return this;
5875 }
5876
5877 /**
5878 * Add extended data to the intent. The name must include a package
5879 * prefix, for example the app com.android.contacts would use names
5880 * like "com.android.contacts.ShowAll".
5881 *
5882 * @param name The name of the extra data, with package prefix.
5883 * @param value The String data value.
5884 *
5885 * @return Returns the same Intent object, for chaining multiple calls
5886 * into a single statement.
5887 *
5888 * @see #putExtras
5889 * @see #removeExtra
5890 * @see #getStringExtra(String)
5891 */
5892 public Intent putExtra(String name, String value) {
5893 if (mExtras == null) {
5894 mExtras = new Bundle();
5895 }
5896 mExtras.putString(name, value);
5897 return this;
5898 }
5899
5900 /**
5901 * Add extended data to the intent. The name must include a package
5902 * prefix, for example the app com.android.contacts would use names
5903 * like "com.android.contacts.ShowAll".
5904 *
5905 * @param name The name of the extra data, with package prefix.
5906 * @param value The CharSequence data value.
5907 *
5908 * @return Returns the same Intent object, for chaining multiple calls
5909 * into a single statement.
5910 *
5911 * @see #putExtras
5912 * @see #removeExtra
5913 * @see #getCharSequenceExtra(String)
5914 */
5915 public Intent putExtra(String name, CharSequence value) {
5916 if (mExtras == null) {
5917 mExtras = new Bundle();
5918 }
5919 mExtras.putCharSequence(name, value);
5920 return this;
5921 }
5922
5923 /**
5924 * Add extended data to the intent. The name must include a package
5925 * prefix, for example the app com.android.contacts would use names
5926 * like "com.android.contacts.ShowAll".
5927 *
5928 * @param name The name of the extra data, with package prefix.
5929 * @param value The Parcelable data value.
5930 *
5931 * @return Returns the same Intent object, for chaining multiple calls
5932 * into a single statement.
5933 *
5934 * @see #putExtras
5935 * @see #removeExtra
5936 * @see #getParcelableExtra(String)
5937 */
5938 public Intent putExtra(String name, Parcelable value) {
5939 if (mExtras == null) {
5940 mExtras = new Bundle();
5941 }
5942 mExtras.putParcelable(name, value);
5943 return this;
5944 }
5945
5946 /**
5947 * Add extended data to the intent. The name must include a package
5948 * prefix, for example the app com.android.contacts would use names
5949 * like "com.android.contacts.ShowAll".
5950 *
5951 * @param name The name of the extra data, with package prefix.
5952 * @param value The Parcelable[] data value.
5953 *
5954 * @return Returns the same Intent object, for chaining multiple calls
5955 * into a single statement.
5956 *
5957 * @see #putExtras
5958 * @see #removeExtra
5959 * @see #getParcelableArrayExtra(String)
5960 */
5961 public Intent putExtra(String name, Parcelable[] value) {
5962 if (mExtras == null) {
5963 mExtras = new Bundle();
5964 }
5965 mExtras.putParcelableArray(name, value);
5966 return this;
5967 }
5968
5969 /**
5970 * Add extended data to the intent. The name must include a package
5971 * prefix, for example the app com.android.contacts would use names
5972 * like "com.android.contacts.ShowAll".
5973 *
5974 * @param name The name of the extra data, with package prefix.
5975 * @param value The ArrayList<Parcelable> data value.
5976 *
5977 * @return Returns the same Intent object, for chaining multiple calls
5978 * into a single statement.
5979 *
5980 * @see #putExtras
5981 * @see #removeExtra
5982 * @see #getParcelableArrayListExtra(String)
5983 */
5984 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5985 if (mExtras == null) {
5986 mExtras = new Bundle();
5987 }
5988 mExtras.putParcelableArrayList(name, value);
5989 return this;
5990 }
5991
5992 /**
5993 * Add extended data to the intent. The name must include a package
5994 * prefix, for example the app com.android.contacts would use names
5995 * like "com.android.contacts.ShowAll".
5996 *
5997 * @param name The name of the extra data, with package prefix.
5998 * @param value The ArrayList<Integer> data value.
5999 *
6000 * @return Returns the same Intent object, for chaining multiple calls
6001 * into a single statement.
6002 *
6003 * @see #putExtras
6004 * @see #removeExtra
6005 * @see #getIntegerArrayListExtra(String)
6006 */
6007 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6008 if (mExtras == null) {
6009 mExtras = new Bundle();
6010 }
6011 mExtras.putIntegerArrayList(name, value);
6012 return this;
6013 }
6014
6015 /**
6016 * Add extended data to the intent. The name must include a package
6017 * prefix, for example the app com.android.contacts would use names
6018 * like "com.android.contacts.ShowAll".
6019 *
6020 * @param name The name of the extra data, with package prefix.
6021 * @param value The ArrayList<String> data value.
6022 *
6023 * @return Returns the same Intent object, for chaining multiple calls
6024 * into a single statement.
6025 *
6026 * @see #putExtras
6027 * @see #removeExtra
6028 * @see #getStringArrayListExtra(String)
6029 */
6030 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6031 if (mExtras == null) {
6032 mExtras = new Bundle();
6033 }
6034 mExtras.putStringArrayList(name, value);
6035 return this;
6036 }
6037
6038 /**
6039 * Add extended data to the intent. The name must include a package
6040 * prefix, for example the app com.android.contacts would use names
6041 * like "com.android.contacts.ShowAll".
6042 *
6043 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006044 * @param value The ArrayList<CharSequence> data value.
6045 *
6046 * @return Returns the same Intent object, for chaining multiple calls
6047 * into a single statement.
6048 *
6049 * @see #putExtras
6050 * @see #removeExtra
6051 * @see #getCharSequenceArrayListExtra(String)
6052 */
6053 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6054 if (mExtras == null) {
6055 mExtras = new Bundle();
6056 }
6057 mExtras.putCharSequenceArrayList(name, value);
6058 return this;
6059 }
6060
6061 /**
6062 * Add extended data to the intent. The name must include a package
6063 * prefix, for example the app com.android.contacts would use names
6064 * like "com.android.contacts.ShowAll".
6065 *
6066 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006067 * @param value The Serializable data value.
6068 *
6069 * @return Returns the same Intent object, for chaining multiple calls
6070 * into a single statement.
6071 *
6072 * @see #putExtras
6073 * @see #removeExtra
6074 * @see #getSerializableExtra(String)
6075 */
6076 public Intent putExtra(String name, Serializable value) {
6077 if (mExtras == null) {
6078 mExtras = new Bundle();
6079 }
6080 mExtras.putSerializable(name, value);
6081 return this;
6082 }
6083
6084 /**
6085 * Add extended data to the intent. The name must include a package
6086 * prefix, for example the app com.android.contacts would use names
6087 * like "com.android.contacts.ShowAll".
6088 *
6089 * @param name The name of the extra data, with package prefix.
6090 * @param value The boolean array data value.
6091 *
6092 * @return Returns the same Intent object, for chaining multiple calls
6093 * into a single statement.
6094 *
6095 * @see #putExtras
6096 * @see #removeExtra
6097 * @see #getBooleanArrayExtra(String)
6098 */
6099 public Intent putExtra(String name, boolean[] value) {
6100 if (mExtras == null) {
6101 mExtras = new Bundle();
6102 }
6103 mExtras.putBooleanArray(name, value);
6104 return this;
6105 }
6106
6107 /**
6108 * Add extended data to the intent. The name must include a package
6109 * prefix, for example the app com.android.contacts would use names
6110 * like "com.android.contacts.ShowAll".
6111 *
6112 * @param name The name of the extra data, with package prefix.
6113 * @param value The byte array data value.
6114 *
6115 * @return Returns the same Intent object, for chaining multiple calls
6116 * into a single statement.
6117 *
6118 * @see #putExtras
6119 * @see #removeExtra
6120 * @see #getByteArrayExtra(String)
6121 */
6122 public Intent putExtra(String name, byte[] value) {
6123 if (mExtras == null) {
6124 mExtras = new Bundle();
6125 }
6126 mExtras.putByteArray(name, value);
6127 return this;
6128 }
6129
6130 /**
6131 * Add extended data to the intent. The name must include a package
6132 * prefix, for example the app com.android.contacts would use names
6133 * like "com.android.contacts.ShowAll".
6134 *
6135 * @param name The name of the extra data, with package prefix.
6136 * @param value The short array data value.
6137 *
6138 * @return Returns the same Intent object, for chaining multiple calls
6139 * into a single statement.
6140 *
6141 * @see #putExtras
6142 * @see #removeExtra
6143 * @see #getShortArrayExtra(String)
6144 */
6145 public Intent putExtra(String name, short[] value) {
6146 if (mExtras == null) {
6147 mExtras = new Bundle();
6148 }
6149 mExtras.putShortArray(name, value);
6150 return this;
6151 }
6152
6153 /**
6154 * Add extended data to the intent. The name must include a package
6155 * prefix, for example the app com.android.contacts would use names
6156 * like "com.android.contacts.ShowAll".
6157 *
6158 * @param name The name of the extra data, with package prefix.
6159 * @param value The char array data value.
6160 *
6161 * @return Returns the same Intent object, for chaining multiple calls
6162 * into a single statement.
6163 *
6164 * @see #putExtras
6165 * @see #removeExtra
6166 * @see #getCharArrayExtra(String)
6167 */
6168 public Intent putExtra(String name, char[] value) {
6169 if (mExtras == null) {
6170 mExtras = new Bundle();
6171 }
6172 mExtras.putCharArray(name, value);
6173 return this;
6174 }
6175
6176 /**
6177 * Add extended data to the intent. The name must include a package
6178 * prefix, for example the app com.android.contacts would use names
6179 * like "com.android.contacts.ShowAll".
6180 *
6181 * @param name The name of the extra data, with package prefix.
6182 * @param value The int array data value.
6183 *
6184 * @return Returns the same Intent object, for chaining multiple calls
6185 * into a single statement.
6186 *
6187 * @see #putExtras
6188 * @see #removeExtra
6189 * @see #getIntArrayExtra(String)
6190 */
6191 public Intent putExtra(String name, int[] value) {
6192 if (mExtras == null) {
6193 mExtras = new Bundle();
6194 }
6195 mExtras.putIntArray(name, value);
6196 return this;
6197 }
6198
6199 /**
6200 * Add extended data to the intent. The name must include a package
6201 * prefix, for example the app com.android.contacts would use names
6202 * like "com.android.contacts.ShowAll".
6203 *
6204 * @param name The name of the extra data, with package prefix.
6205 * @param value The byte array data value.
6206 *
6207 * @return Returns the same Intent object, for chaining multiple calls
6208 * into a single statement.
6209 *
6210 * @see #putExtras
6211 * @see #removeExtra
6212 * @see #getLongArrayExtra(String)
6213 */
6214 public Intent putExtra(String name, long[] value) {
6215 if (mExtras == null) {
6216 mExtras = new Bundle();
6217 }
6218 mExtras.putLongArray(name, value);
6219 return this;
6220 }
6221
6222 /**
6223 * Add extended data to the intent. The name must include a package
6224 * prefix, for example the app com.android.contacts would use names
6225 * like "com.android.contacts.ShowAll".
6226 *
6227 * @param name The name of the extra data, with package prefix.
6228 * @param value The float array data value.
6229 *
6230 * @return Returns the same Intent object, for chaining multiple calls
6231 * into a single statement.
6232 *
6233 * @see #putExtras
6234 * @see #removeExtra
6235 * @see #getFloatArrayExtra(String)
6236 */
6237 public Intent putExtra(String name, float[] value) {
6238 if (mExtras == null) {
6239 mExtras = new Bundle();
6240 }
6241 mExtras.putFloatArray(name, value);
6242 return this;
6243 }
6244
6245 /**
6246 * Add extended data to the intent. The name must include a package
6247 * prefix, for example the app com.android.contacts would use names
6248 * like "com.android.contacts.ShowAll".
6249 *
6250 * @param name The name of the extra data, with package prefix.
6251 * @param value The double array data value.
6252 *
6253 * @return Returns the same Intent object, for chaining multiple calls
6254 * into a single statement.
6255 *
6256 * @see #putExtras
6257 * @see #removeExtra
6258 * @see #getDoubleArrayExtra(String)
6259 */
6260 public Intent putExtra(String name, double[] value) {
6261 if (mExtras == null) {
6262 mExtras = new Bundle();
6263 }
6264 mExtras.putDoubleArray(name, value);
6265 return this;
6266 }
6267
6268 /**
6269 * Add extended data to the intent. The name must include a package
6270 * prefix, for example the app com.android.contacts would use names
6271 * like "com.android.contacts.ShowAll".
6272 *
6273 * @param name The name of the extra data, with package prefix.
6274 * @param value The String array data value.
6275 *
6276 * @return Returns the same Intent object, for chaining multiple calls
6277 * into a single statement.
6278 *
6279 * @see #putExtras
6280 * @see #removeExtra
6281 * @see #getStringArrayExtra(String)
6282 */
6283 public Intent putExtra(String name, String[] value) {
6284 if (mExtras == null) {
6285 mExtras = new Bundle();
6286 }
6287 mExtras.putStringArray(name, value);
6288 return this;
6289 }
6290
6291 /**
6292 * Add extended data to the intent. The name must include a package
6293 * prefix, for example the app com.android.contacts would use names
6294 * like "com.android.contacts.ShowAll".
6295 *
6296 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006297 * @param value The CharSequence array data value.
6298 *
6299 * @return Returns the same Intent object, for chaining multiple calls
6300 * into a single statement.
6301 *
6302 * @see #putExtras
6303 * @see #removeExtra
6304 * @see #getCharSequenceArrayExtra(String)
6305 */
6306 public Intent putExtra(String name, CharSequence[] value) {
6307 if (mExtras == null) {
6308 mExtras = new Bundle();
6309 }
6310 mExtras.putCharSequenceArray(name, value);
6311 return this;
6312 }
6313
6314 /**
6315 * Add extended data to the intent. The name must include a package
6316 * prefix, for example the app com.android.contacts would use names
6317 * like "com.android.contacts.ShowAll".
6318 *
6319 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006320 * @param value The Bundle data value.
6321 *
6322 * @return Returns the same Intent object, for chaining multiple calls
6323 * into a single statement.
6324 *
6325 * @see #putExtras
6326 * @see #removeExtra
6327 * @see #getBundleExtra(String)
6328 */
6329 public Intent putExtra(String name, Bundle value) {
6330 if (mExtras == null) {
6331 mExtras = new Bundle();
6332 }
6333 mExtras.putBundle(name, value);
6334 return this;
6335 }
6336
6337 /**
6338 * Add extended data to the intent. The name must include a package
6339 * prefix, for example the app com.android.contacts would use names
6340 * like "com.android.contacts.ShowAll".
6341 *
6342 * @param name The name of the extra data, with package prefix.
6343 * @param value The IBinder data value.
6344 *
6345 * @return Returns the same Intent object, for chaining multiple calls
6346 * into a single statement.
6347 *
6348 * @see #putExtras
6349 * @see #removeExtra
6350 * @see #getIBinderExtra(String)
6351 *
6352 * @deprecated
6353 * @hide
6354 */
6355 @Deprecated
6356 public Intent putExtra(String name, IBinder value) {
6357 if (mExtras == null) {
6358 mExtras = new Bundle();
6359 }
6360 mExtras.putIBinder(name, value);
6361 return this;
6362 }
6363
6364 /**
6365 * Copy all extras in 'src' in to this intent.
6366 *
6367 * @param src Contains the extras to copy.
6368 *
6369 * @see #putExtra
6370 */
6371 public Intent putExtras(Intent src) {
6372 if (src.mExtras != null) {
6373 if (mExtras == null) {
6374 mExtras = new Bundle(src.mExtras);
6375 } else {
6376 mExtras.putAll(src.mExtras);
6377 }
6378 }
6379 return this;
6380 }
6381
6382 /**
6383 * Add a set of extended data to the intent. The keys must include a package
6384 * prefix, for example the app com.android.contacts would use names
6385 * like "com.android.contacts.ShowAll".
6386 *
6387 * @param extras The Bundle of extras to add to this intent.
6388 *
6389 * @see #putExtra
6390 * @see #removeExtra
6391 */
6392 public Intent putExtras(Bundle extras) {
6393 if (mExtras == null) {
6394 mExtras = new Bundle();
6395 }
6396 mExtras.putAll(extras);
6397 return this;
6398 }
6399
6400 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006401 * Completely replace the extras in the Intent with the extras in the
6402 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006403 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006404 * @param src The exact extras contained in this Intent are copied
6405 * into the target intent, replacing any that were previously there.
6406 */
6407 public Intent replaceExtras(Intent src) {
6408 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6409 return this;
6410 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006411
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006412 /**
6413 * Completely replace the extras in the Intent with the given Bundle of
6414 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006415 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006416 * @param extras The new set of extras in the Intent, or null to erase
6417 * all extras.
6418 */
6419 public Intent replaceExtras(Bundle extras) {
6420 mExtras = extras != null ? new Bundle(extras) : null;
6421 return this;
6422 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006423
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006424 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006425 * Remove extended data from the intent.
6426 *
6427 * @see #putExtra
6428 */
6429 public void removeExtra(String name) {
6430 if (mExtras != null) {
6431 mExtras.remove(name);
6432 if (mExtras.size() == 0) {
6433 mExtras = null;
6434 }
6435 }
6436 }
6437
6438 /**
6439 * Set special flags controlling how this intent is handled. Most values
6440 * here depend on the type of component being executed by the Intent,
6441 * specifically the FLAG_ACTIVITY_* flags are all for use with
6442 * {@link Context#startActivity Context.startActivity()} and the
6443 * FLAG_RECEIVER_* flags are all for use with
6444 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6445 *
Scott Main7aee61f2011-02-08 11:25:01 -08006446 * <p>See the
6447 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6448 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006449 * the behavior of your application.
6450 *
6451 * @param flags The desired flags.
6452 *
6453 * @return Returns the same Intent object, for chaining multiple calls
6454 * into a single statement.
6455 *
6456 * @see #getFlags
6457 * @see #addFlags
6458 *
6459 * @see #FLAG_GRANT_READ_URI_PERMISSION
6460 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006461 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6462 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006463 * @see #FLAG_DEBUG_LOG_RESOLUTION
6464 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006465 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006466 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006467 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006468 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006469 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6470 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006471 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006472 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006473 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006474 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006475 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006476 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006477 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006478 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6479 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006480 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006481 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006482 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006483 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6484 */
6485 public Intent setFlags(int flags) {
6486 mFlags = flags;
6487 return this;
6488 }
6489
6490 /**
6491 * Add additional flags to the intent (or with existing flags
6492 * value).
6493 *
6494 * @param flags The new flags to set.
6495 *
6496 * @return Returns the same Intent object, for chaining multiple calls
6497 * into a single statement.
6498 *
6499 * @see #setFlags
6500 */
6501 public Intent addFlags(int flags) {
6502 mFlags |= flags;
6503 return this;
6504 }
6505
6506 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006507 * (Usually optional) Set an explicit application package name that limits
6508 * the components this Intent will resolve to. If left to the default
6509 * value of null, all components in all applications will considered.
6510 * If non-null, the Intent can only match the components in the given
6511 * application package.
6512 *
6513 * @param packageName The name of the application package to handle the
6514 * intent, or null to allow any application package.
6515 *
6516 * @return Returns the same Intent object, for chaining multiple calls
6517 * into a single statement.
6518 *
6519 * @see #getPackage
6520 * @see #resolveActivity
6521 */
6522 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006523 if (packageName != null && mSelector != null) {
6524 throw new IllegalArgumentException(
6525 "Can't set package name when selector is already set");
6526 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006527 mPackage = packageName;
6528 return this;
6529 }
6530
6531 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006532 * (Usually optional) Explicitly set the component to handle the intent.
6533 * If left with the default value of null, the system will determine the
6534 * appropriate class to use based on the other fields (action, data,
6535 * type, categories) in the Intent. If this class is defined, the
6536 * specified class will always be used regardless of the other fields. You
6537 * should only set this value when you know you absolutely want a specific
6538 * class to be used; otherwise it is better to let the system find the
6539 * appropriate class so that you will respect the installed applications
6540 * and user preferences.
6541 *
6542 * @param component The name of the application component to handle the
6543 * intent, or null to let the system find one for you.
6544 *
6545 * @return Returns the same Intent object, for chaining multiple calls
6546 * into a single statement.
6547 *
6548 * @see #setClass
6549 * @see #setClassName(Context, String)
6550 * @see #setClassName(String, String)
6551 * @see #getComponent
6552 * @see #resolveActivity
6553 */
6554 public Intent setComponent(ComponentName component) {
6555 mComponent = component;
6556 return this;
6557 }
6558
6559 /**
6560 * Convenience for calling {@link #setComponent} with an
6561 * explicit class name.
6562 *
6563 * @param packageContext A Context of the application package implementing
6564 * this class.
6565 * @param className The name of a class inside of the application package
6566 * that will be used as the component for this Intent.
6567 *
6568 * @return Returns the same Intent object, for chaining multiple calls
6569 * into a single statement.
6570 *
6571 * @see #setComponent
6572 * @see #setClass
6573 */
6574 public Intent setClassName(Context packageContext, String className) {
6575 mComponent = new ComponentName(packageContext, className);
6576 return this;
6577 }
6578
6579 /**
6580 * Convenience for calling {@link #setComponent} with an
6581 * explicit application package name and class name.
6582 *
6583 * @param packageName The name of the package implementing the desired
6584 * component.
6585 * @param className The name of a class inside of the application package
6586 * that will be used as the component for this Intent.
6587 *
6588 * @return Returns the same Intent object, for chaining multiple calls
6589 * into a single statement.
6590 *
6591 * @see #setComponent
6592 * @see #setClass
6593 */
6594 public Intent setClassName(String packageName, String className) {
6595 mComponent = new ComponentName(packageName, className);
6596 return this;
6597 }
6598
6599 /**
6600 * Convenience for calling {@link #setComponent(ComponentName)} with the
6601 * name returned by a {@link Class} object.
6602 *
6603 * @param packageContext A Context of the application package implementing
6604 * this class.
6605 * @param cls The class name to set, equivalent to
6606 * <code>setClassName(context, cls.getName())</code>.
6607 *
6608 * @return Returns the same Intent object, for chaining multiple calls
6609 * into a single statement.
6610 *
6611 * @see #setComponent
6612 */
6613 public Intent setClass(Context packageContext, Class<?> cls) {
6614 mComponent = new ComponentName(packageContext, cls);
6615 return this;
6616 }
6617
6618 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006619 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6620 * used as a hint to the receiver for animations and the like. Null means that there
6621 * is no source bounds.
6622 */
6623 public void setSourceBounds(Rect r) {
6624 if (r != null) {
6625 mSourceBounds = new Rect(r);
6626 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006627 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006628 }
6629 }
6630
Tor Norbyed9273d62013-05-30 15:59:53 -07006631 /** @hide */
6632 @IntDef(flag = true,
6633 value = {
6634 FILL_IN_ACTION,
6635 FILL_IN_DATA,
6636 FILL_IN_CATEGORIES,
6637 FILL_IN_COMPONENT,
6638 FILL_IN_PACKAGE,
6639 FILL_IN_SOURCE_BOUNDS,
6640 FILL_IN_SELECTOR,
6641 FILL_IN_CLIP_DATA
6642 })
6643 @Retention(RetentionPolicy.SOURCE)
6644 public @interface FillInFlags {}
6645
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006646 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006647 * Use with {@link #fillIn} to allow the current action value to be
6648 * overwritten, even if it is already set.
6649 */
6650 public static final int FILL_IN_ACTION = 1<<0;
6651
6652 /**
6653 * Use with {@link #fillIn} to allow the current data or type value
6654 * overwritten, even if it is already set.
6655 */
6656 public static final int FILL_IN_DATA = 1<<1;
6657
6658 /**
6659 * Use with {@link #fillIn} to allow the current categories to be
6660 * overwritten, even if they are already set.
6661 */
6662 public static final int FILL_IN_CATEGORIES = 1<<2;
6663
6664 /**
6665 * Use with {@link #fillIn} to allow the current component value to be
6666 * overwritten, even if it is already set.
6667 */
6668 public static final int FILL_IN_COMPONENT = 1<<3;
6669
6670 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006671 * Use with {@link #fillIn} to allow the current package value to be
6672 * overwritten, even if it is already set.
6673 */
6674 public static final int FILL_IN_PACKAGE = 1<<4;
6675
6676 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006677 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006678 * overwritten, even if it is already set.
6679 */
6680 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6681
6682 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006683 * Use with {@link #fillIn} to allow the current selector to be
6684 * overwritten, even if it is already set.
6685 */
6686 public static final int FILL_IN_SELECTOR = 1<<6;
6687
6688 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006689 * Use with {@link #fillIn} to allow the current ClipData to be
6690 * overwritten, even if it is already set.
6691 */
6692 public static final int FILL_IN_CLIP_DATA = 1<<7;
6693
6694 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006695 * Copy the contents of <var>other</var> in to this object, but only
6696 * where fields are not defined by this object. For purposes of a field
6697 * being defined, the following pieces of data in the Intent are
6698 * considered to be separate fields:
6699 *
6700 * <ul>
6701 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006702 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006703 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6704 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006705 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006706 * <li> component, as set by {@link #setComponent(ComponentName)} or
6707 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006708 * <li> source bounds, as set by {@link #setSourceBounds}.
6709 * <li> selector, as set by {@link #setSelector(Intent)}.
6710 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006711 * <li> each top-level name in the associated extras.
6712 * </ul>
6713 *
6714 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006715 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006716 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6717 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6718 * the restriction where the corresponding field will not be replaced if
6719 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006720 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006721 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6722 * is explicitly specified. The selector will only be copied if
6723 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006724 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006725 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6726 * and Intent B with {action="gotit", data-type="some/thing",
6727 * categories="one","two"}.
6728 *
6729 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6730 * containing: {action="gotit", data-type="some/thing",
6731 * categories="bar"}.
6732 *
6733 * @param other Another Intent whose values are to be used to fill in
6734 * the current one.
6735 * @param flags Options to control which fields can be filled in.
6736 *
6737 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006738 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006739 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6740 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6741 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006742 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006743 @FillInFlags
6744 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006745 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006746 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006747 if (other.mAction != null
6748 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006749 mAction = other.mAction;
6750 changes |= FILL_IN_ACTION;
6751 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006752 if ((other.mData != null || other.mType != null)
6753 && ((mData == null && mType == null)
6754 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006755 mData = other.mData;
6756 mType = other.mType;
6757 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006758 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006759 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006760 if (other.mCategories != null
6761 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006762 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006763 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006764 }
6765 changes |= FILL_IN_CATEGORIES;
6766 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006767 if (other.mPackage != null
6768 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006769 // Only do this if mSelector is not set.
6770 if (mSelector == null) {
6771 mPackage = other.mPackage;
6772 changes |= FILL_IN_PACKAGE;
6773 }
6774 }
6775 // Selector is special: it can only be set if explicitly allowed,
6776 // for the same reason as the component name.
6777 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6778 if (mPackage == null) {
6779 mSelector = new Intent(other.mSelector);
6780 mPackage = null;
6781 changes |= FILL_IN_SELECTOR;
6782 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006783 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006784 if (other.mClipData != null
6785 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6786 mClipData = other.mClipData;
6787 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006788 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006789 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006790 // Component is special: it can -only- be set if explicitly allowed,
6791 // since otherwise the sender could force the intent somewhere the
6792 // originator didn't intend.
6793 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006794 mComponent = other.mComponent;
6795 changes |= FILL_IN_COMPONENT;
6796 }
6797 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006798 if (other.mSourceBounds != null
6799 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6800 mSourceBounds = new Rect(other.mSourceBounds);
6801 changes |= FILL_IN_SOURCE_BOUNDS;
6802 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006803 if (mExtras == null) {
6804 if (other.mExtras != null) {
6805 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006806 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006807 }
6808 } else if (other.mExtras != null) {
6809 try {
6810 Bundle newb = new Bundle(other.mExtras);
6811 newb.putAll(mExtras);
6812 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006813 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006814 } catch (RuntimeException e) {
6815 // Modifying the extras can cause us to unparcel the contents
6816 // of the bundle, and if we do this in the system process that
6817 // may fail. We really should handle this (i.e., the Bundle
6818 // impl shouldn't be on top of a plain map), but for now just
6819 // ignore it and keep the original contents. :(
6820 Log.w("Intent", "Failure filling in extras", e);
6821 }
6822 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006823 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
6824 && other.mContentUserHint != UserHandle.USER_CURRENT) {
6825 mContentUserHint = other.mContentUserHint;
6826 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006827 return changes;
6828 }
6829
6830 /**
6831 * Wrapper class holding an Intent and implementing comparisons on it for
6832 * the purpose of filtering. The class implements its
6833 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6834 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6835 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6836 * on the wrapped Intent.
6837 */
6838 public static final class FilterComparison {
6839 private final Intent mIntent;
6840 private final int mHashCode;
6841
6842 public FilterComparison(Intent intent) {
6843 mIntent = intent;
6844 mHashCode = intent.filterHashCode();
6845 }
6846
6847 /**
6848 * Return the Intent that this FilterComparison represents.
6849 * @return Returns the Intent held by the FilterComparison. Do
6850 * not modify!
6851 */
6852 public Intent getIntent() {
6853 return mIntent;
6854 }
6855
6856 @Override
6857 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006858 if (obj instanceof FilterComparison) {
6859 Intent other = ((FilterComparison)obj).mIntent;
6860 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006861 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006862 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006863 }
6864
6865 @Override
6866 public int hashCode() {
6867 return mHashCode;
6868 }
6869 }
6870
6871 /**
6872 * Determine if two intents are the same for the purposes of intent
6873 * resolution (filtering). That is, if their action, data, type,
6874 * class, and categories are the same. This does <em>not</em> compare
6875 * any extra data included in the intents.
6876 *
6877 * @param other The other Intent to compare against.
6878 *
6879 * @return Returns true if action, data, type, class, and categories
6880 * are the same.
6881 */
6882 public boolean filterEquals(Intent other) {
6883 if (other == null) {
6884 return false;
6885 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07006886 if (!Objects.equals(this.mAction, other.mAction)) return false;
6887 if (!Objects.equals(this.mData, other.mData)) return false;
6888 if (!Objects.equals(this.mType, other.mType)) return false;
6889 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6890 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6891 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006892
6893 return true;
6894 }
6895
6896 /**
6897 * Generate hash code that matches semantics of filterEquals().
6898 *
6899 * @return Returns the hash value of the action, data, type, class, and
6900 * categories.
6901 *
6902 * @see #filterEquals
6903 */
6904 public int filterHashCode() {
6905 int code = 0;
6906 if (mAction != null) {
6907 code += mAction.hashCode();
6908 }
6909 if (mData != null) {
6910 code += mData.hashCode();
6911 }
6912 if (mType != null) {
6913 code += mType.hashCode();
6914 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006915 if (mPackage != null) {
6916 code += mPackage.hashCode();
6917 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006918 if (mComponent != null) {
6919 code += mComponent.hashCode();
6920 }
6921 if (mCategories != null) {
6922 code += mCategories.hashCode();
6923 }
6924 return code;
6925 }
6926
6927 @Override
6928 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006929 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006930
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006931 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006932 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006933 b.append(" }");
6934
6935 return b.toString();
6936 }
6937
6938 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006939 public String toInsecureString() {
6940 StringBuilder b = new StringBuilder(128);
6941
6942 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006943 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006944 b.append(" }");
6945
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006946 return b.toString();
6947 }
Romain Guy4969af72009-06-17 10:53:19 -07006948
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006949 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006950 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006951 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006952
6953 b.append("Intent { ");
6954 toShortString(b, false, true, true, true);
6955 b.append(" }");
6956
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006957 return b.toString();
6958 }
6959
6960 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006961 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6962 StringBuilder b = new StringBuilder(128);
6963 toShortString(b, secure, comp, extras, clip);
6964 return b.toString();
6965 }
6966
6967 /** @hide */
6968 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6969 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006970 boolean first = true;
6971 if (mAction != null) {
6972 b.append("act=").append(mAction);
6973 first = false;
6974 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006975 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006976 if (!first) {
6977 b.append(' ');
6978 }
6979 first = false;
6980 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006981 for (int i=0; i<mCategories.size(); i++) {
6982 if (i > 0) b.append(',');
6983 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006984 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006985 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006986 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006987 if (mData != null) {
6988 if (!first) {
6989 b.append(' ');
6990 }
6991 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006992 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006993 if (secure) {
6994 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006995 } else {
6996 b.append(mData);
6997 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006998 }
6999 if (mType != null) {
7000 if (!first) {
7001 b.append(' ');
7002 }
7003 first = false;
7004 b.append("typ=").append(mType);
7005 }
7006 if (mFlags != 0) {
7007 if (!first) {
7008 b.append(' ');
7009 }
7010 first = false;
7011 b.append("flg=0x").append(Integer.toHexString(mFlags));
7012 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007013 if (mPackage != null) {
7014 if (!first) {
7015 b.append(' ');
7016 }
7017 first = false;
7018 b.append("pkg=").append(mPackage);
7019 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007020 if (comp && mComponent != null) {
7021 if (!first) {
7022 b.append(' ');
7023 }
7024 first = false;
7025 b.append("cmp=").append(mComponent.flattenToShortString());
7026 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007027 if (mSourceBounds != null) {
7028 if (!first) {
7029 b.append(' ');
7030 }
7031 first = false;
7032 b.append("bnds=").append(mSourceBounds.toShortString());
7033 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007034 if (mClipData != null) {
7035 if (!first) {
7036 b.append(' ');
7037 }
7038 first = false;
7039 if (clip) {
7040 b.append("clip={");
7041 mClipData.toShortString(b);
7042 b.append('}');
7043 } else {
7044 b.append("(has clip)");
7045 }
7046 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007047 if (extras && mExtras != null) {
7048 if (!first) {
7049 b.append(' ');
7050 }
7051 first = false;
7052 b.append("(has extras)");
7053 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007054 if (mContentUserHint != UserHandle.USER_CURRENT) {
7055 if (!first) {
7056 b.append(' ');
7057 }
7058 first = false;
7059 b.append("u=").append(mContentUserHint);
7060 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007061 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007062 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007063 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007064 b.append("}");
7065 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007066 }
7067
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007068 /**
7069 * Call {@link #toUri} with 0 flags.
7070 * @deprecated Use {@link #toUri} instead.
7071 */
7072 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007073 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007074 return toUri(0);
7075 }
7076
7077 /**
7078 * Convert this Intent into a String holding a URI representation of it.
7079 * The returned URI string has been properly URI encoded, so it can be
7080 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7081 * Intent's data as the base URI, with an additional fragment describing
7082 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007083 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007084 * <p>You can convert the returned string back to an Intent with
7085 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007086 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007087 * @param flags Additional operating flags. Either 0 or
7088 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007089 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007090 * @return Returns a URI encoding URI string describing the entire contents
7091 * of the Intent.
7092 */
7093 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007094 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007095 String scheme = null;
7096 if (mData != null) {
7097 String data = mData.toString();
7098 if ((flags&URI_INTENT_SCHEME) != 0) {
7099 final int N = data.length();
7100 for (int i=0; i<N; i++) {
7101 char c = data.charAt(i);
7102 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7103 || c == '.' || c == '-') {
7104 continue;
7105 }
7106 if (c == ':' && i > 0) {
7107 // Valid scheme.
7108 scheme = data.substring(0, i);
7109 uri.append("intent:");
7110 data = data.substring(i+1);
7111 break;
7112 }
Tom Taylord4a47292009-12-21 13:59:18 -08007113
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007114 // No scheme.
7115 break;
7116 }
7117 }
7118 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007119
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007120 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7121 uri.append("intent:");
7122 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007123
7124 uri.append("#Intent;");
7125
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007126 toUriInner(uri, scheme, flags);
7127 if (mSelector != null) {
7128 uri.append("SEL;");
7129 // Note that for now we are not going to try to handle the
7130 // data part; not clear how to represent this as a URI, and
7131 // not much utility in it.
7132 mSelector.toUriInner(uri, null, flags);
7133 }
7134
7135 uri.append("end");
7136
7137 return uri.toString();
7138 }
7139
7140 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007141 if (scheme != null) {
7142 uri.append("scheme=").append(scheme).append(';');
7143 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007144 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007145 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007146 }
7147 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007148 for (int i=0; i<mCategories.size(); i++) {
7149 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007150 }
7151 }
7152 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007153 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007154 }
7155 if (mFlags != 0) {
7156 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7157 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007158 if (mPackage != null) {
7159 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7160 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007161 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007162 uri.append("component=").append(Uri.encode(
7163 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007164 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007165 if (mSourceBounds != null) {
7166 uri.append("sourceBounds=")
7167 .append(Uri.encode(mSourceBounds.flattenToString()))
7168 .append(';');
7169 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007170 if (mExtras != null) {
7171 for (String key : mExtras.keySet()) {
7172 final Object value = mExtras.get(key);
7173 char entryType =
7174 value instanceof String ? 'S' :
7175 value instanceof Boolean ? 'B' :
7176 value instanceof Byte ? 'b' :
7177 value instanceof Character ? 'c' :
7178 value instanceof Double ? 'd' :
7179 value instanceof Float ? 'f' :
7180 value instanceof Integer ? 'i' :
7181 value instanceof Long ? 'l' :
7182 value instanceof Short ? 's' :
7183 '\0';
7184
7185 if (entryType != '\0') {
7186 uri.append(entryType);
7187 uri.append('.');
7188 uri.append(Uri.encode(key));
7189 uri.append('=');
7190 uri.append(Uri.encode(value.toString()));
7191 uri.append(';');
7192 }
7193 }
7194 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007195 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007196
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007197 public int describeContents() {
7198 return (mExtras != null) ? mExtras.describeContents() : 0;
7199 }
7200
7201 public void writeToParcel(Parcel out, int flags) {
7202 out.writeString(mAction);
7203 Uri.writeToParcel(out, mData);
7204 out.writeString(mType);
7205 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007206 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 ComponentName.writeToParcel(mComponent, out);
7208
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007209 if (mSourceBounds != null) {
7210 out.writeInt(1);
7211 mSourceBounds.writeToParcel(out, flags);
7212 } else {
7213 out.writeInt(0);
7214 }
7215
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007216 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007217 final int N = mCategories.size();
7218 out.writeInt(N);
7219 for (int i=0; i<N; i++) {
7220 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007221 }
7222 } else {
7223 out.writeInt(0);
7224 }
7225
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007226 if (mSelector != null) {
7227 out.writeInt(1);
7228 mSelector.writeToParcel(out, flags);
7229 } else {
7230 out.writeInt(0);
7231 }
7232
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007233 if (mClipData != null) {
7234 out.writeInt(1);
7235 mClipData.writeToParcel(out, flags);
7236 } else {
7237 out.writeInt(0);
7238 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007239 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007240 out.writeBundle(mExtras);
7241 }
7242
7243 public static final Parcelable.Creator<Intent> CREATOR
7244 = new Parcelable.Creator<Intent>() {
7245 public Intent createFromParcel(Parcel in) {
7246 return new Intent(in);
7247 }
7248 public Intent[] newArray(int size) {
7249 return new Intent[size];
7250 }
7251 };
7252
Dianne Hackborneb034652009-09-07 00:49:58 -07007253 /** @hide */
7254 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007255 readFromParcel(in);
7256 }
7257
7258 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007259 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007260 mData = Uri.CREATOR.createFromParcel(in);
7261 mType = in.readString();
7262 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007263 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007264 mComponent = ComponentName.readFromParcel(in);
7265
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007266 if (in.readInt() != 0) {
7267 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7268 }
7269
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007270 int N = in.readInt();
7271 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007272 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007273 int i;
7274 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007275 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007276 }
7277 } else {
7278 mCategories = null;
7279 }
7280
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007281 if (in.readInt() != 0) {
7282 mSelector = new Intent(in);
7283 }
7284
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007285 if (in.readInt() != 0) {
7286 mClipData = new ClipData(in);
7287 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007288 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007289 mExtras = in.readBundle();
7290 }
7291
7292 /**
7293 * Parses the "intent" element (and its children) from XML and instantiates
7294 * an Intent object. The given XML parser should be located at the tag
7295 * where parsing should start (often named "intent"), from which the
7296 * basic action, data, type, and package and class name will be
7297 * retrieved. The function will then parse in to any child elements,
7298 * looking for <category android:name="xxx"> tags to add categories and
7299 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7300 * to the intent.
7301 *
7302 * @param resources The Resources to use when inflating resources.
7303 * @param parser The XML parser pointing at an "intent" tag.
7304 * @param attrs The AttributeSet interface for retrieving extended
7305 * attribute data at the current <var>parser</var> location.
7306 * @return An Intent object matching the XML data.
7307 * @throws XmlPullParserException If there was an XML parsing error.
7308 * @throws IOException If there was an I/O error.
7309 */
7310 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7311 throws XmlPullParserException, IOException {
7312 Intent intent = new Intent();
7313
7314 TypedArray sa = resources.obtainAttributes(attrs,
7315 com.android.internal.R.styleable.Intent);
7316
7317 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7318
7319 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7320 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7321 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7322
7323 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7324 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7325 if (packageName != null && className != null) {
7326 intent.setComponent(new ComponentName(packageName, className));
7327 }
7328
7329 sa.recycle();
7330
7331 int outerDepth = parser.getDepth();
7332 int type;
7333 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7334 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7335 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7336 continue;
7337 }
7338
7339 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007340 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007341 sa = resources.obtainAttributes(attrs,
7342 com.android.internal.R.styleable.IntentCategory);
7343 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7344 sa.recycle();
7345
7346 if (cat != null) {
7347 intent.addCategory(cat);
7348 }
7349 XmlUtils.skipCurrentTag(parser);
7350
Craig Mautner21d24a22014-04-23 11:45:37 -07007351 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007352 if (intent.mExtras == null) {
7353 intent.mExtras = new Bundle();
7354 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007355 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007356 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007357
7358 } else {
7359 XmlUtils.skipCurrentTag(parser);
7360 }
7361 }
7362
7363 return intent;
7364 }
Nick Pellyccae4122012-01-09 14:12:58 -08007365
Craig Mautner21d24a22014-04-23 11:45:37 -07007366 /** @hide */
7367 public void saveToXml(XmlSerializer out) throws IOException {
7368 if (mAction != null) {
7369 out.attribute(null, ATTR_ACTION, mAction);
7370 }
7371 if (mData != null) {
7372 out.attribute(null, ATTR_DATA, mData.toString());
7373 }
7374 if (mType != null) {
7375 out.attribute(null, ATTR_TYPE, mType);
7376 }
7377 if (mComponent != null) {
7378 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7379 }
7380 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7381
7382 if (mCategories != null) {
7383 out.startTag(null, TAG_CATEGORIES);
7384 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7385 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7386 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007387 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007388 }
7389 }
7390
7391 /** @hide */
7392 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7393 XmlPullParserException {
7394 Intent intent = new Intent();
7395 final int outerDepth = in.getDepth();
7396
7397 int attrCount = in.getAttributeCount();
7398 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7399 final String attrName = in.getAttributeName(attrNdx);
7400 final String attrValue = in.getAttributeValue(attrNdx);
7401 if (ATTR_ACTION.equals(attrName)) {
7402 intent.setAction(attrValue);
7403 } else if (ATTR_DATA.equals(attrName)) {
7404 intent.setData(Uri.parse(attrValue));
7405 } else if (ATTR_TYPE.equals(attrName)) {
7406 intent.setType(attrValue);
7407 } else if (ATTR_COMPONENT.equals(attrName)) {
7408 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7409 } else if (ATTR_FLAGS.equals(attrName)) {
7410 intent.setFlags(Integer.valueOf(attrValue, 16));
7411 } else {
7412 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7413 }
7414 }
7415
7416 int event;
7417 String name;
7418 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7419 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7420 if (event == XmlPullParser.START_TAG) {
7421 name = in.getName();
7422 if (TAG_CATEGORIES.equals(name)) {
7423 attrCount = in.getAttributeCount();
7424 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7425 intent.addCategory(in.getAttributeValue(attrNdx));
7426 }
7427 } else {
7428 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7429 XmlUtils.skipCurrentTag(in);
7430 }
7431 }
7432 }
7433
7434 return intent;
7435 }
7436
Nick Pellyccae4122012-01-09 14:12:58 -08007437 /**
7438 * Normalize a MIME data type.
7439 *
7440 * <p>A normalized MIME type has white-space trimmed,
7441 * content-type parameters removed, and is lower-case.
7442 * This aligns the type with Android best practices for
7443 * intent filtering.
7444 *
7445 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7446 * "text/x-vCard" becomes "text/x-vcard".
7447 *
7448 * <p>All MIME types received from outside Android (such as user input,
7449 * or external sources like Bluetooth, NFC, or the Internet) should
7450 * be normalized before they are used to create an Intent.
7451 *
7452 * @param type MIME data type to normalize
7453 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007454 * @see #setType
7455 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007456 */
7457 public static String normalizeMimeType(String type) {
7458 if (type == null) {
7459 return null;
7460 }
7461
Elliott Hughescb64d432013-08-02 10:00:44 -07007462 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007463
7464 final int semicolonIndex = type.indexOf(';');
7465 if (semicolonIndex != -1) {
7466 type = type.substring(0, semicolonIndex);
7467 }
7468 return type;
7469 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007470
7471 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007472 * Prepare this {@link Intent} to leave an app process.
7473 *
7474 * @hide
7475 */
7476 public void prepareToLeaveProcess() {
7477 setAllowFds(false);
7478
7479 if (mSelector != null) {
7480 mSelector.prepareToLeaveProcess();
7481 }
7482 if (mClipData != null) {
7483 mClipData.prepareToLeaveProcess();
7484 }
7485
7486 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7487 // There are several ACTION_MEDIA_* broadcasts that send file://
7488 // Uris, so only check common actions.
7489 if (ACTION_VIEW.equals(mAction) ||
7490 ACTION_EDIT.equals(mAction) ||
7491 ACTION_ATTACH_DATA.equals(mAction)) {
7492 mData.checkFileUriExposed("Intent.getData()");
7493 }
7494 }
7495 }
7496
7497 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007498 * @hide
7499 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007500 public void prepareToEnterProcess() {
7501 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00007502 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
7503 fixUris(mContentUserHint);
7504 mContentUserHint = UserHandle.USER_CURRENT;
7505 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007506 }
7507 }
7508
7509 /**
7510 * @hide
7511 */
7512 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007513 Uri data = getData();
7514 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007515 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007516 }
7517 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007518 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007519 }
7520 String action = getAction();
7521 if (ACTION_SEND.equals(action)) {
7522 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7523 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007524 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007525 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007526 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007527 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7528 if (streams != null) {
7529 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7530 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007531 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007532 }
7533 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7534 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007535 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7536 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7537 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7538 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7539 if (output != null) {
7540 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7541 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007542 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007543 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007544
7545 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007546 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007547 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7548 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007549 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007550 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007551 * @hide
7552 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007553 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007554 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007555 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007556
7557 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007558 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007559
7560 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007561 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007562 // Inspect contained intents to see if we need to migrate extras. We
7563 // don't promote ClipData to the parent, since ChooserActivity will
7564 // already start the picked item as the caller, and we can't combine
7565 // the flags in a safe way.
7566
7567 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07007568 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007569 final Intent intent = getParcelableExtra(EXTRA_INTENT);
7570 if (intent != null) {
7571 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07007572 }
7573 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007574 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007575 try {
7576 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
7577 if (intents != null) {
7578 for (int i = 0; i < intents.length; i++) {
7579 final Intent intent = (Intent) intents[i];
7580 if (intent != null) {
7581 migrated |= intent.migrateExtraStreamToClipData();
7582 }
7583 }
7584 }
7585 } catch (ClassCastException e) {
7586 }
7587 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007588
7589 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007590 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007591 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7592 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7593 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7594 if (stream != null || text != null || htmlText != null) {
7595 final ClipData clipData = new ClipData(
7596 null, new String[] { getType() },
7597 new ClipData.Item(text, htmlText, null, stream));
7598 setClipData(clipData);
7599 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007600 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007601 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007602 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007603 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007604
7605 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007606 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007607 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7608 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7609 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7610 int num = -1;
7611 if (streams != null) {
7612 num = streams.size();
7613 }
7614 if (texts != null) {
7615 if (num >= 0 && num != texts.size()) {
7616 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007617 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007618 }
7619 num = texts.size();
7620 }
7621 if (htmlTexts != null) {
7622 if (num >= 0 && num != htmlTexts.size()) {
7623 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007624 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007625 }
7626 num = htmlTexts.size();
7627 }
7628 if (num > 0) {
7629 final ClipData clipData = new ClipData(
7630 null, new String[] { getType() },
7631 makeClipItem(streams, texts, htmlTexts, 0));
7632
7633 for (int i = 1; i < num; i++) {
7634 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7635 }
7636
7637 setClipData(clipData);
7638 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007639 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007640 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007641 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007642 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007643 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7644 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7645 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7646 final Uri output;
7647 try {
7648 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7649 } catch (ClassCastException e) {
7650 return false;
7651 }
7652 if (output != null) {
7653 setClipData(ClipData.newRawUri("", output));
7654 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
7655 return true;
7656 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007657 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007658
7659 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007660 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007661
7662 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7663 ArrayList<String> htmlTexts, int which) {
7664 Uri uri = streams != null ? streams.get(which) : null;
7665 CharSequence text = texts != null ? texts.get(which) : null;
7666 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7667 return new ClipData.Item(text, htmlText, null, uri);
7668 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007669
7670 /** @hide */
7671 public boolean isDocument() {
7672 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7673 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007674}