blob: 3dfa78b4804cd4032304792b7620ff187af1048e [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;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070020import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070021
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070022import org.xmlpull.v1.XmlPullParser;
23import org.xmlpull.v1.XmlPullParserException;
24
Tor Norbyed9273d62013-05-30 15:59:53 -070025import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070026import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
28import android.content.pm.ActivityInfo;
Nicolas Prevotd85fc722014-04-16 19:52:08 +010029import static android.content.ContentProvider.maybeAddUserId;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.content.pm.PackageManager;
31import android.content.pm.ResolveInfo;
32import android.content.res.Resources;
33import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080034import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070035import android.net.Uri;
36import android.os.Bundle;
37import android.os.IBinder;
38import android.os.Parcel;
39import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070040import android.os.StrictMode;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070041import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070042import android.provider.DocumentsProvider;
43import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070044import android.util.AttributeSet;
45import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080046
47import com.android.internal.util.XmlUtils;
Craig Mautner21d24a22014-04-23 11:45:37 -070048import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070049
50import java.io.IOException;
51import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070052import java.lang.annotation.Retention;
53import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import java.net.URISyntaxException;
55import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070056import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080057import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070058import java.util.Set;
59
60/**
61 * An intent is an abstract description of an operation to be performed. It
62 * can be used with {@link Context#startActivity(Intent) startActivity} to
63 * launch an {@link android.app.Activity},
64 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
65 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
66 * and {@link android.content.Context#startService} or
67 * {@link android.content.Context#bindService} to communicate with a
68 * background {@link android.app.Service}.
69 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070070 * <p>An Intent provides a facility for performing late runtime binding between the code in
71 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070072 * can be thought of as the glue between activities. It is basically a passive data structure
73 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070074 *
75 * <div class="special reference">
76 * <h3>Developer Guides</h3>
77 * <p>For information about how to create and resolve intents, read the
78 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
79 * developer guide.</p>
80 * </div>
81 *
82 * <a name="IntentStructure"></a>
83 * <h3>Intent Structure</h3>
84 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070085 *
86 * <ul>
87 * <li> <p><b>action</b> -- The general action to be performed, such as
88 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
89 * etc.</p>
90 * </li>
91 * <li> <p><b>data</b> -- The data to operate on, such as a person record
92 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
93 * </li>
94 * </ul>
95 *
96 *
97 * <p>Some examples of action/data pairs are:</p>
98 *
99 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700100 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700101 * information about the person whose identifier is "1".</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * the phone dialer with the person filled in.</p>
105 * </li>
106 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
107 * the phone dialer with the given number filled in. Note how the
108 * VIEW action does what what is considered the most reasonable thing for
109 * a particular URI.</p>
110 * </li>
111 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
112 * the phone dialer with the given number filled in.</p>
113 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700114 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700115 * information about the person whose identifier is "1".</p>
116 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700117 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700118 * a list of people, which the user can browse through. This example is a
119 * typical top-level entry into the Contacts application, showing you the
120 * list of people. Selecting a particular person to view would result in a
121 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
122 * being used to start an activity to display that person.</p>
123 * </li>
124 * </ul>
125 *
126 * <p>In addition to these primary attributes, there are a number of secondary
127 * attributes that you can also include with an intent:</p>
128 *
129 * <ul>
130 * <li> <p><b>category</b> -- Gives additional information about the action
131 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
132 * appear in the Launcher as a top-level application, while
133 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
134 * of alternative actions the user can perform on a piece of data.</p>
135 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
136 * intent data. Normally the type is inferred from the data itself.
137 * By setting this attribute, you disable that evaluation and force
138 * an explicit type.</p>
139 * <li> <p><b>component</b> -- Specifies an explicit name of a component
140 * class to use for the intent. Normally this is determined by looking
141 * at the other information in the intent (the action, data/type, and
142 * categories) and matching that with a component that can handle it.
143 * If this attribute is set then none of the evaluation is performed,
144 * and this component is used exactly as is. By specifying this attribute,
145 * all of the other Intent attributes become optional.</p>
146 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
147 * This can be used to provide extended information to the component.
148 * For example, if we have a action to send an e-mail message, we could
149 * also include extra pieces of data here to supply a subject, body,
150 * etc.</p>
151 * </ul>
152 *
153 * <p>Here are some examples of other operations you can specify as intents
154 * using these additional parameters:</p>
155 *
156 * <ul>
157 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
158 * Launch the home screen.</p>
159 * </li>
160 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
161 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
162 * vnd.android.cursor.item/phone}</i></b>
163 * -- Display the list of people's phone numbers, allowing the user to
164 * browse through them and pick one and return it to the parent activity.</p>
165 * </li>
166 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
167 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
168 * -- Display all pickers for data that can be opened with
169 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
170 * allowing the user to pick one of them and then some data inside of it
171 * and returning the resulting URI to the caller. This can be used,
172 * for example, in an e-mail application to allow the user to pick some
173 * data to include as an attachment.</p>
174 * </li>
175 * </ul>
176 *
177 * <p>There are a variety of standard Intent action and category constants
178 * defined in the Intent class, but applications can also define their own.
179 * These strings use java style scoping, to ensure they are unique -- for
180 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700181 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700182 *
183 * <p>Put together, the set of actions, data types, categories, and extra data
184 * defines a language for the system allowing for the expression of phrases
185 * such as "call john smith's cell". As applications are added to the system,
186 * they can extend this language by adding new actions, types, and categories, or
187 * they can modify the behavior of existing phrases by supplying their own
188 * activities that handle them.</p>
189 *
190 * <a name="IntentResolution"></a>
191 * <h3>Intent Resolution</h3>
192 *
193 * <p>There are two primary forms of intents you will use.
194 *
195 * <ul>
196 * <li> <p><b>Explicit Intents</b> have specified a component (via
197 * {@link #setComponent} or {@link #setClass}), which provides the exact
198 * class to be run. Often these will not include any other information,
199 * simply being a way for an application to launch various internal
200 * activities it has as the user interacts with the application.
201 *
202 * <li> <p><b>Implicit Intents</b> have not specified a component;
203 * instead, they must include enough information for the system to
204 * determine which of the available components is best to run for that
205 * intent.
206 * </ul>
207 *
208 * <p>When using implicit intents, given such an arbitrary intent we need to
209 * know what to do with it. This is handled by the process of <em>Intent
210 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
211 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
212 * more activities/receivers) that can handle it.</p>
213 *
214 * <p>The intent resolution mechanism basically revolves around matching an
215 * Intent against all of the &lt;intent-filter&gt; descriptions in the
216 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
217 * objects explicitly registered with {@link Context#registerReceiver}.) More
218 * details on this can be found in the documentation on the {@link
219 * IntentFilter} class.</p>
220 *
221 * <p>There are three pieces of information in the Intent that are used for
222 * resolution: the action, type, and category. Using this information, a query
223 * is done on the {@link PackageManager} for a component that can handle the
224 * intent. The appropriate component is determined based on the intent
225 * information supplied in the <code>AndroidManifest.xml</code> file as
226 * follows:</p>
227 *
228 * <ul>
229 * <li> <p>The <b>action</b>, if given, must be listed by the component as
230 * one it handles.</p>
231 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
232 * already supplied in the Intent. Like the action, if a type is
233 * included in the intent (either explicitly or implicitly in its
234 * data), then this must be listed by the component as one it handles.</p>
235 * <li> For data that is not a <code>content:</code> URI and where no explicit
236 * type is included in the Intent, instead the <b>scheme</b> of the
237 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
238 * considered. Again like the action, if we are matching a scheme it
239 * must be listed by the component as one it can handle.
240 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
241 * by the activity as categories it handles. That is, if you include
242 * the categories {@link #CATEGORY_LAUNCHER} and
243 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
244 * with an intent that lists <em>both</em> of those categories.
245 * Activities will very often need to support the
246 * {@link #CATEGORY_DEFAULT} so that they can be found by
247 * {@link Context#startActivity Context.startActivity()}.</p>
248 * </ul>
249 *
250 * <p>For example, consider the Note Pad sample application that
251 * allows user to browse through a list of notes data and view details about
252 * individual items. Text in italics indicate places were you would replace a
253 * name with one specific to your own package.</p>
254 *
255 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
256 * package="<i>com.android.notepad</i>"&gt;
257 * &lt;application android:icon="@drawable/app_notes"
258 * android:label="@string/app_name"&gt;
259 *
260 * &lt;provider class=".NotePadProvider"
261 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
262 *
263 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.MAIN" /&gt;
266 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700267 * &lt;/intent-filter&gt;
268 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700269 * &lt;action android:name="android.intent.action.VIEW" /&gt;
270 * &lt;action android:name="android.intent.action.EDIT" /&gt;
271 * &lt;action android:name="android.intent.action.PICK" /&gt;
272 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
273 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700274 * &lt;/intent-filter&gt;
275 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700276 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
277 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
278 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700279 * &lt;/intent-filter&gt;
280 * &lt;/activity&gt;
281 *
282 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
283 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700284 * &lt;action android:name="android.intent.action.VIEW" /&gt;
285 * &lt;action android:name="android.intent.action.EDIT" /&gt;
286 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
287 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700288 * &lt;/intent-filter&gt;
289 *
290 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700291 * &lt;action android:name="android.intent.action.INSERT" /&gt;
292 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
293 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700294 * &lt;/intent-filter&gt;
295 *
296 * &lt;/activity&gt;
297 *
298 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
299 * android:theme="@android:style/Theme.Dialog"&gt;
300 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
304 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
305 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700306 * &lt;/intent-filter&gt;
307 * &lt;/activity&gt;
308 *
309 * &lt;/application&gt;
310 * &lt;/manifest&gt;</pre>
311 *
312 * <p>The first activity,
313 * <code>com.android.notepad.NotesList</code>, serves as our main
314 * entry into the app. It can do three things as described by its three intent
315 * templates:
316 * <ol>
317 * <li><pre>
318 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700319 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700321 * &lt;/intent-filter&gt;</pre>
322 * <p>This provides a top-level entry into the NotePad application: the standard
323 * MAIN action is a main entry point (not requiring any other information in
324 * the Intent), and the LAUNCHER category says that this entry point should be
325 * listed in the application launcher.</p>
326 * <li><pre>
327 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700328 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
329 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
330 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
331 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
332 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700333 * &lt;/intent-filter&gt;</pre>
334 * <p>This declares the things that the activity can do on a directory of
335 * notes. The type being supported is given with the &lt;type&gt; tag, where
336 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
337 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
338 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
339 * The activity allows the user to view or edit the directory of data (via
340 * the VIEW and EDIT actions), or to pick a particular note and return it
341 * to the caller (via the PICK action). Note also the DEFAULT category
342 * supplied here: this is <em>required</em> for the
343 * {@link Context#startActivity Context.startActivity} method to resolve your
344 * activity when its component name is not explicitly specified.</p>
345 * <li><pre>
346 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700347 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
348 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
349 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700350 * &lt;/intent-filter&gt;</pre>
351 * <p>This filter describes the ability return to the caller a note selected by
352 * the user without needing to know where it came from. The data type
353 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
354 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
355 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
356 * The GET_CONTENT action is similar to the PICK action, where the activity
357 * will return to its caller a piece of data selected by the user. Here,
358 * however, the caller specifies the type of data they desire instead of
359 * the type of data the user will be picking from.</p>
360 * </ol>
361 *
362 * <p>Given these capabilities, the following intents will resolve to the
363 * NotesList activity:</p>
364 *
365 * <ul>
366 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
367 * activities that can be used as top-level entry points into an
368 * application.</p>
369 * <li> <p><b>{ action=android.app.action.MAIN,
370 * category=android.app.category.LAUNCHER }</b> is the actual intent
371 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700372 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700373 * data=content://com.google.provider.NotePad/notes }</b>
374 * displays a list of all the notes under
375 * "content://com.google.provider.NotePad/notes", which
376 * the user can browse through and see the details on.</p>
377 * <li> <p><b>{ action=android.app.action.PICK
378 * data=content://com.google.provider.NotePad/notes }</b>
379 * provides a list of the notes under
380 * "content://com.google.provider.NotePad/notes", from which
381 * the user can pick a note whose data URL is returned back to the caller.</p>
382 * <li> <p><b>{ action=android.app.action.GET_CONTENT
383 * type=vnd.android.cursor.item/vnd.google.note }</b>
384 * is similar to the pick action, but allows the caller to specify the
385 * kind of data they want back so that the system can find the appropriate
386 * activity to pick something of that data type.</p>
387 * </ul>
388 *
389 * <p>The second activity,
390 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
391 * note entry and allows them to edit it. It can do two things as described
392 * by its two intent templates:
393 * <ol>
394 * <li><pre>
395 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700396 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
397 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
398 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
399 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700400 * &lt;/intent-filter&gt;</pre>
401 * <p>The first, primary, purpose of this activity is to let the user interact
402 * with a single note, as decribed by the MIME type
403 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
404 * either VIEW a note or allow the user to EDIT it. Again we support the
405 * DEFAULT category to allow the activity to be launched without explicitly
406 * specifying its component.</p>
407 * <li><pre>
408 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700409 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
410 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
411 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700412 * &lt;/intent-filter&gt;</pre>
413 * <p>The secondary use of this activity is to insert a new note entry into
414 * an existing directory of notes. This is used when the user creates a new
415 * note: the INSERT action is executed on the directory of notes, causing
416 * this activity to run and have the user create the new note data which
417 * it then adds to the content provider.</p>
418 * </ol>
419 *
420 * <p>Given these capabilities, the following intents will resolve to the
421 * NoteEditor activity:</p>
422 *
423 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700424 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700425 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
426 * shows the user the content of note <var>{ID}</var>.</p>
427 * <li> <p><b>{ action=android.app.action.EDIT
428 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
429 * allows the user to edit the content of note <var>{ID}</var>.</p>
430 * <li> <p><b>{ action=android.app.action.INSERT
431 * data=content://com.google.provider.NotePad/notes }</b>
432 * creates a new, empty note in the notes list at
433 * "content://com.google.provider.NotePad/notes"
434 * and allows the user to edit it. If they keep their changes, the URI
435 * of the newly created note is returned to the caller.</p>
436 * </ul>
437 *
438 * <p>The last activity,
439 * <code>com.android.notepad.TitleEditor</code>, allows the user to
440 * edit the title of a note. This could be implemented as a class that the
441 * application directly invokes (by explicitly setting its component in
442 * the Intent), but here we show a way you can publish alternative
443 * operations on existing data:</p>
444 *
445 * <pre>
446 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700447 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
448 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
449 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
450 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
451 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700452 * &lt;/intent-filter&gt;</pre>
453 *
454 * <p>In the single intent template here, we
455 * have created our own private action called
456 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
457 * edit the title of a note. It must be invoked on a specific note
458 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
459 * view and edit actions, but here displays and edits the title contained
460 * in the note data.
461 *
462 * <p>In addition to supporting the default category as usual, our title editor
463 * also supports two other standard categories: ALTERNATIVE and
464 * SELECTED_ALTERNATIVE. Implementing
465 * these categories allows others to find the special action it provides
466 * without directly knowing about it, through the
467 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
468 * more often to build dynamic menu items with
469 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
470 * template here was also supply an explicit name for the template
471 * (via <code>android:label="@string/resolve_title"</code>) to better control
472 * what the user sees when presented with this activity as an alternative
473 * action to the data they are viewing.
474 *
475 * <p>Given these capabilities, the following intent will resolve to the
476 * TitleEditor activity:</p>
477 *
478 * <ul>
479 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
480 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
481 * displays and allows the user to edit the title associated
482 * with note <var>{ID}</var>.</p>
483 * </ul>
484 *
485 * <h3>Standard Activity Actions</h3>
486 *
487 * <p>These are the current standard actions that Intent defines for launching
488 * activities (usually through {@link Context#startActivity}. The most
489 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
490 * {@link #ACTION_EDIT}.
491 *
492 * <ul>
493 * <li> {@link #ACTION_MAIN}
494 * <li> {@link #ACTION_VIEW}
495 * <li> {@link #ACTION_ATTACH_DATA}
496 * <li> {@link #ACTION_EDIT}
497 * <li> {@link #ACTION_PICK}
498 * <li> {@link #ACTION_CHOOSER}
499 * <li> {@link #ACTION_GET_CONTENT}
500 * <li> {@link #ACTION_DIAL}
501 * <li> {@link #ACTION_CALL}
502 * <li> {@link #ACTION_SEND}
503 * <li> {@link #ACTION_SENDTO}
504 * <li> {@link #ACTION_ANSWER}
505 * <li> {@link #ACTION_INSERT}
506 * <li> {@link #ACTION_DELETE}
507 * <li> {@link #ACTION_RUN}
508 * <li> {@link #ACTION_SYNC}
509 * <li> {@link #ACTION_PICK_ACTIVITY}
510 * <li> {@link #ACTION_SEARCH}
511 * <li> {@link #ACTION_WEB_SEARCH}
512 * <li> {@link #ACTION_FACTORY_TEST}
513 * </ul>
514 *
515 * <h3>Standard Broadcast Actions</h3>
516 *
517 * <p>These are the current standard actions that Intent defines for receiving
518 * broadcasts (usually through {@link Context#registerReceiver} or a
519 * &lt;receiver&gt; tag in a manifest).
520 *
521 * <ul>
522 * <li> {@link #ACTION_TIME_TICK}
523 * <li> {@link #ACTION_TIME_CHANGED}
524 * <li> {@link #ACTION_TIMEZONE_CHANGED}
525 * <li> {@link #ACTION_BOOT_COMPLETED}
526 * <li> {@link #ACTION_PACKAGE_ADDED}
527 * <li> {@link #ACTION_PACKAGE_CHANGED}
528 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800529 * <li> {@link #ACTION_PACKAGE_RESTARTED}
530 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #ACTION_UID_REMOVED}
532 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700533 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700534 * <li> {@link #ACTION_POWER_DISCONNECTED}
535 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700536 * </ul>
537 *
538 * <h3>Standard Categories</h3>
539 *
540 * <p>These are the current standard categories that can be used to further
541 * clarify an Intent via {@link #addCategory}.
542 *
543 * <ul>
544 * <li> {@link #CATEGORY_DEFAULT}
545 * <li> {@link #CATEGORY_BROWSABLE}
546 * <li> {@link #CATEGORY_TAB}
547 * <li> {@link #CATEGORY_ALTERNATIVE}
548 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
549 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800550 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700551 * <li> {@link #CATEGORY_HOME}
552 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700553 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400554 * <li> {@link #CATEGORY_CAR_DOCK}
555 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500556 * <li> {@link #CATEGORY_LE_DESK_DOCK}
557 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200558 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700559 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700560 * </ul>
561 *
562 * <h3>Standard Extra Data</h3>
563 *
564 * <p>These are the current standard fields that can be used as extra data via
565 * {@link #putExtra}.
566 *
567 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800568 * <li> {@link #EXTRA_ALARM_COUNT}
569 * <li> {@link #EXTRA_BCC}
570 * <li> {@link #EXTRA_CC}
571 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
572 * <li> {@link #EXTRA_DATA_REMOVED}
573 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500574 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
575 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_DOCK_STATE_CAR}
577 * <li> {@link #EXTRA_DOCK_STATE_DESK}
578 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
579 * <li> {@link #EXTRA_DONT_KILL_APP}
580 * <li> {@link #EXTRA_EMAIL}
581 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700582 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700584 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800585 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700586 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800587 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
588 * <li> {@link #EXTRA_REPLACING}
589 * <li> {@link #EXTRA_SHORTCUT_ICON}
590 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
591 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700592 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_SHORTCUT_NAME}
594 * <li> {@link #EXTRA_SUBJECT}
595 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700596 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_TITLE}
598 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 * </ul>
600 *
601 * <h3>Flags</h3>
602 *
603 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800604 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
605 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800607public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700608 private static final String ATTR_ACTION = "action";
609 private static final String TAG_CATEGORIES = "categories";
610 private static final String ATTR_CATEGORY = "category";
611 private static final String TAG_EXTRA = "extra";
612 private static final String ATTR_TYPE = "type";
613 private static final String ATTR_COMPONENT = "component";
614 private static final String ATTR_DATA = "data";
615 private static final String ATTR_FLAGS = "flags";
616
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700617 // ---------------------------------------------------------------------
618 // ---------------------------------------------------------------------
619 // Standard intent activity actions (see action variable).
620
621 /**
622 * Activity Action: Start as a main entry point, does not expect to
623 * receive data.
624 * <p>Input: nothing
625 * <p>Output: nothing
626 */
627 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
628 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Activity Action: Display the data to the user. This is the most common
632 * action performed on data -- it is the generic action you can use on
633 * a piece of data to get the most reasonable thing to occur. For example,
634 * when used on a contacts entry it will view the entry; when used on a
635 * mailto: URI it will bring up a compose window filled with the information
636 * supplied by the URI; when used with a tel: URI it will invoke the
637 * dialer.
638 * <p>Input: {@link #getData} is URI from which to retrieve data.
639 * <p>Output: nothing.
640 */
641 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
642 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800643
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700644 /**
645 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
646 * performed on a piece of data.
647 */
648 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700650 /**
651 * Used to indicate that some piece of data should be attached to some other
652 * place. For example, image data could be attached to a contact. It is up
653 * to the recipient to decide where the data should be attached; the intent
654 * does not specify the ultimate destination.
655 * <p>Input: {@link #getData} is URI of data to be attached.
656 * <p>Output: nothing.
657 */
658 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
659 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700661 /**
662 * Activity Action: Provide explicit editable access to the given data.
663 * <p>Input: {@link #getData} is URI of data to be edited.
664 * <p>Output: nothing.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_EDIT = "android.intent.action.EDIT";
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: Pick an existing item, or insert a new item, and then edit it.
671 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
672 * The extras can contain type specific data to pass through to the editing/creating
673 * activity.
674 * <p>Output: The URI of the item that was picked. This must be a content:
675 * URI so that any receiver can access it.
676 */
677 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
678 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800679
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 /**
681 * Activity Action: Pick an item from the data, returning what was selected.
682 * <p>Input: {@link #getData} is URI containing a directory of data
683 * (vnd.android.cursor.dir/*) from which to pick an item.
684 * <p>Output: The URI of the item that was picked.
685 */
686 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
687 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700689 /**
690 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800691 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700692 * <p>Output: An Intent representing the shortcut. The intent must contain three
693 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
694 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800695 * (value: ShortcutIconResource).</p>
696 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700697 * @see #EXTRA_SHORTCUT_INTENT
698 * @see #EXTRA_SHORTCUT_NAME
699 * @see #EXTRA_SHORTCUT_ICON
700 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
701 * @see android.content.Intent.ShortcutIconResource
702 */
703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
704 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
705
706 /**
707 * The name of the extra used to define the Intent of a shortcut.
708 *
709 * @see #ACTION_CREATE_SHORTCUT
710 */
711 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
712 /**
713 * The name of the extra used to define the name of a shortcut.
714 *
715 * @see #ACTION_CREATE_SHORTCUT
716 */
717 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
718 /**
719 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
720 *
721 * @see #ACTION_CREATE_SHORTCUT
722 */
723 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
724 /**
725 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
726 *
727 * @see #ACTION_CREATE_SHORTCUT
728 * @see android.content.Intent.ShortcutIconResource
729 */
730 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
731 "android.intent.extra.shortcut.ICON_RESOURCE";
732
733 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800734 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700735 *
736 * @see Intent#ACTION_CREATE_SHORTCUT
737 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800738 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
739 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700740 */
741 public static class ShortcutIconResource implements Parcelable {
742 /**
743 * The package name of the application containing the icon.
744 */
745 public String packageName;
746
747 /**
748 * The resource name of the icon, including package, name and type.
749 */
750 public String resourceName;
751
752 /**
753 * Creates a new ShortcutIconResource for the specified context and resource
754 * identifier.
755 *
756 * @param context The context of the application.
757 * @param resourceId The resource idenfitier for the icon.
758 * @return A new ShortcutIconResource with the specified's context package name
759 * and icon resource idenfitier.
760 */
761 public static ShortcutIconResource fromContext(Context context, int resourceId) {
762 ShortcutIconResource icon = new ShortcutIconResource();
763 icon.packageName = context.getPackageName();
764 icon.resourceName = context.getResources().getResourceName(resourceId);
765 return icon;
766 }
767
768 /**
769 * Used to read a ShortcutIconResource from a Parcel.
770 */
771 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
772 new Parcelable.Creator<ShortcutIconResource>() {
773
774 public ShortcutIconResource createFromParcel(Parcel source) {
775 ShortcutIconResource icon = new ShortcutIconResource();
776 icon.packageName = source.readString();
777 icon.resourceName = source.readString();
778 return icon;
779 }
780
781 public ShortcutIconResource[] newArray(int size) {
782 return new ShortcutIconResource[size];
783 }
784 };
785
786 /**
787 * No special parcel contents.
788 */
789 public int describeContents() {
790 return 0;
791 }
792
793 public void writeToParcel(Parcel dest, int flags) {
794 dest.writeString(packageName);
795 dest.writeString(resourceName);
796 }
797
798 @Override
799 public String toString() {
800 return resourceName;
801 }
802 }
803
804 /**
805 * Activity Action: Display an activity chooser, allowing the user to pick
806 * what they want to before proceeding. This can be used as an alternative
807 * to the standard activity picker that is displayed by the system when
808 * you try to start an activity with multiple possible matches, with these
809 * differences in behavior:
810 * <ul>
811 * <li>You can specify the title that will appear in the activity chooser.
812 * <li>The user does not have the option to make one of the matching
813 * activities a preferred activity, and all possible activities will
814 * always be shown even if one of them is currently marked as the
815 * preferred activity.
816 * </ul>
817 * <p>
818 * This action should be used when the user will naturally expect to
819 * select an activity in order to proceed. An example if when not to use
820 * it is when the user clicks on a "mailto:" link. They would naturally
821 * expect to go directly to their mail app, so startActivity() should be
822 * called directly: it will
823 * either launch the current preferred app, or put up a dialog allowing the
824 * user to pick an app to use and optionally marking that as preferred.
825 * <p>
826 * In contrast, if the user is selecting a menu item to send a picture
827 * they are viewing to someone else, there are many different things they
828 * may want to do at this point: send it through e-mail, upload it to a
829 * web service, etc. In this case the CHOOSER action should be used, to
830 * always present to the user a list of the things they can do, with a
831 * nice title given by the caller such as "Send this photo with:".
832 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700833 * If you need to grant URI permissions through a chooser, you must specify
834 * the permissions to be granted on the ACTION_CHOOSER Intent
835 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
836 * {@link #setClipData} to specify the URIs to be granted as well as
837 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
838 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
839 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700840 * As a convenience, an Intent of this form can be created with the
841 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700842 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700843 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
845 * and can optionally have a {@link #EXTRA_TITLE} field containing the
846 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700847 * <p>
848 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700849 */
850 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
851 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
852
853 /**
854 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
855 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700856 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
857 * target intent, also optionally supplying a title. If the target
858 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
859 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
860 * set in the returned chooser intent, with its ClipData set appropriately:
861 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500862 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700863 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700864 * @param target The Intent that the user will be selecting an activity
865 * to perform.
866 * @param title Optional title that will be displayed in the chooser.
867 * @return Return a new Intent object that you can hand to
868 * {@link Context#startActivity(Intent) Context.startActivity()} and
869 * related methods.
870 */
871 public static Intent createChooser(Intent target, CharSequence title) {
872 Intent intent = new Intent(ACTION_CHOOSER);
873 intent.putExtra(EXTRA_INTENT, target);
874 if (title != null) {
875 intent.putExtra(EXTRA_TITLE, title);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877
878 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700879 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
880 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
881 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700882 if (permFlags != 0) {
883 ClipData targetClipData = target.getClipData();
884 if (targetClipData == null && target.getData() != null) {
885 ClipData.Item item = new ClipData.Item(target.getData());
886 String[] mimeTypes;
887 if (target.getType() != null) {
888 mimeTypes = new String[] { target.getType() };
889 } else {
890 mimeTypes = new String[] { };
891 }
892 targetClipData = new ClipData(null, mimeTypes, item);
893 }
894 if (targetClipData != null) {
895 intent.setClipData(targetClipData);
896 intent.addFlags(permFlags);
897 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700898 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700899
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700900 return intent;
901 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700902
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700903 /**
904 * Activity Action: Allow the user to select a particular kind of data and
905 * return it. This is different than {@link #ACTION_PICK} in that here we
906 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800907 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700908 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900909 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * etc.
911 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900912 * 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 -0700913 * of data, such as a person contact, you set the MIME type to the kind of
914 * data you want and launch it with {@link Context#startActivity(Intent)}.
915 * The system will then launch the best application to select that kind
916 * of data for you.
917 * <p>
918 * You may also be interested in any of a set of types of content the user
919 * can pick. For example, an e-mail application that wants to allow the
920 * user to add an attachment to an e-mail message can use this action to
921 * bring up a list of all of the types of content the user can attach.
922 * <p>
923 * In this case, you should wrap the GET_CONTENT intent with a chooser
924 * (through {@link #createChooser}), which will give the proper interface
925 * for the user to pick how to send your data and allow you to specify
926 * a prompt indicating what they are doing. You will usually specify a
927 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
928 * broad range of content types the user can select from.
929 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900930 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700931 * only pick from data that can be represented as a stream. This is
932 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
933 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800934 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900935 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800936 * is locally available on the device. For example, if this extra is set
937 * to true then an image picker should not show any pictures that are available
938 * from a remote server but not already on the local device (thus requiring
939 * they be downloaded when opened).
940 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800941 * If the caller can handle multiple returned items (the user performing
942 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
943 * to indicate this.
944 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700945 * Input: {@link #getType} is the desired MIME type to retrieve. Note
946 * that no URI is supplied in the intent, as there are no constraints on
947 * where the returned data originally comes from. You may also include the
948 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800949 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800950 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
951 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700952 * <p>
953 * Output: The URI of the item that was picked. This must be a content:
954 * URI so that any receiver can access it.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
958 /**
959 * Activity Action: Dial a number as specified by the data. This shows a
960 * UI with the number being dialed, allowing the user to explicitly
961 * initiate the call.
962 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
963 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
964 * number.
965 * <p>Output: nothing.
966 */
967 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
968 public static final String ACTION_DIAL = "android.intent.action.DIAL";
969 /**
970 * Activity Action: Perform a call to someone specified by the data.
971 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
972 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
973 * number.
974 * <p>Output: nothing.
975 *
976 * <p>Note: there will be restrictions on which applications can initiate a
977 * call; most applications should use the {@link #ACTION_DIAL}.
978 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
979 * numbers. Applications can <strong>dial</strong> emergency numbers using
980 * {@link #ACTION_DIAL}, however.
981 */
982 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
983 public static final String ACTION_CALL = "android.intent.action.CALL";
984 /**
985 * Activity Action: Perform a call to an emergency number specified by the
986 * data.
987 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
988 * tel: URI of an explicit phone number.
989 * <p>Output: nothing.
990 * @hide
991 */
992 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
993 /**
994 * Activity action: Perform a call to any number (emergency or not)
995 * specified by the data.
996 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
997 * tel: URI of an explicit phone number.
998 * <p>Output: nothing.
999 * @hide
1000 */
1001 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1002 /**
1003 * Activity Action: Send a message to someone specified by the data.
1004 * <p>Input: {@link #getData} is URI describing the target.
1005 * <p>Output: nothing.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1009 /**
1010 * Activity Action: Deliver some data to someone else. Who the data is
1011 * being delivered to is not specified; it is up to the receiver of this
1012 * action to ask the user where the data should be sent.
1013 * <p>
1014 * When launching a SEND intent, you should usually wrap it in a chooser
1015 * (through {@link #createChooser}), which will give the proper interface
1016 * for the user to pick how to send your data and allow you to specify
1017 * a prompt indicating what they are doing.
1018 * <p>
1019 * Input: {@link #getType} is the MIME type of the data being sent.
1020 * get*Extra can have either a {@link #EXTRA_TEXT}
1021 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1022 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1023 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1024 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001025 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1026 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1027 * your text with HTML formatting.
1028 * <p>
1029 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1030 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1031 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1032 * content: URIs and other advanced features of {@link ClipData}. If
1033 * using this approach, you still must supply the same data through the
1034 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1035 * for compatibility with old applications. If you don't set a ClipData,
1036 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001037 * <p>
1038 * Optional standard extras, which may be interpreted by some recipients as
1039 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1040 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1041 * <p>
1042 * Output: nothing.
1043 */
1044 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1045 public static final String ACTION_SEND = "android.intent.action.SEND";
1046 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001047 * Activity Action: Deliver multiple data to someone else.
1048 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001049 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001050 * <p>
1051 * Input: {@link #getType} is the MIME type of the data being sent.
1052 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001053 * #EXTRA_STREAM} field, containing the data to be sent. If using
1054 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1055 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001056 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001057 * Multiple types are supported, and receivers should handle mixed types
1058 * whenever possible. The right way for the receiver to check them is to
1059 * use the content resolver on each URI. The intent sender should try to
1060 * put the most concrete mime type in the intent type, but it can fall
1061 * back to {@literal <type>/*} or {@literal *}/* as needed.
1062 * <p>
1063 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1064 * be image/jpg, but if you are sending image/jpg and image/png, then the
1065 * intent's type should be image/*.
1066 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001067 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1068 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1069 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1070 * content: URIs and other advanced features of {@link ClipData}. If
1071 * using this approach, you still must supply the same data through the
1072 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1073 * for compatibility with old applications. If you don't set a ClipData,
1074 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1075 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001076 * Optional standard extras, which may be interpreted by some recipients as
1077 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1078 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1079 * <p>
1080 * Output: nothing.
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1084 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001085 * Activity Action: Handle an incoming phone call.
1086 * <p>Input: nothing.
1087 * <p>Output: nothing.
1088 */
1089 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1090 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1091 /**
1092 * Activity Action: Insert an empty item into the given container.
1093 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1094 * in which to place the data.
1095 * <p>Output: URI of the new data that was created.
1096 */
1097 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1098 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1099 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001100 * Activity Action: Create a new item in the given container, initializing it
1101 * from the current contents of the clipboard.
1102 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1103 * in which to place the data.
1104 * <p>Output: URI of the new data that was created.
1105 */
1106 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1107 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1108 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001109 * Activity Action: Delete the given data from its container.
1110 * <p>Input: {@link #getData} is URI of data to be deleted.
1111 * <p>Output: nothing.
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1115 /**
1116 * Activity Action: Run the data, whatever that means.
1117 * <p>Input: ? (Note: this is currently specific to the test harness.)
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_RUN = "android.intent.action.RUN";
1122 /**
1123 * Activity Action: Perform a data synchronization.
1124 * <p>Input: ?
1125 * <p>Output: ?
1126 */
1127 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1128 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1129 /**
1130 * Activity Action: Pick an activity given an intent, returning the class
1131 * selected.
1132 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1133 * used with {@link PackageManager#queryIntentActivities} to determine the
1134 * set of activities from which to pick.
1135 * <p>Output: Class name of the activity that was selected.
1136 */
1137 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1138 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1139 /**
1140 * Activity Action: Perform a search.
1141 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1142 * is the text to search for. If empty, simply
1143 * enter your search results Activity with the search UI activated.
1144 * <p>Output: nothing.
1145 */
1146 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1147 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1148 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001149 * Activity Action: Start the platform-defined tutorial
1150 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1151 * is the text to search for. If empty, simply
1152 * enter your search results Activity with the search UI activated.
1153 * <p>Output: nothing.
1154 */
1155 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1156 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1157 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001158 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001159 * <p>
1160 * Input: {@link android.app.SearchManager#QUERY
1161 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1162 * a url starts with http or https, the site will be opened. If it is plain
1163 * text, Google search will be applied.
1164 * <p>
1165 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001166 */
1167 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1168 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001169
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001170 /**
Jim Miller07994402012-05-02 14:22:27 -07001171 * Activity Action: Perform assist action.
1172 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001173 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1174 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001175 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001176 * Output: nothing.
1177 */
1178 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1179 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001180
1181 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001182 * Activity Action: Perform voice assist action.
1183 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001184 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1185 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001186 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001187 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001188 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001189 */
1190 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1191 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1192
1193 /**
Adam Skory7140a252013-09-11 12:04:58 +01001194 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1195 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001196 */
1197 public static final String EXTRA_ASSIST_PACKAGE
1198 = "android.intent.extra.ASSIST_PACKAGE";
1199
1200 /**
Adam Skory7140a252013-09-11 12:04:58 +01001201 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1202 * information supplied by the current foreground app at the time of the assist request.
1203 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001204 */
1205 public static final String EXTRA_ASSIST_CONTEXT
1206 = "android.intent.extra.ASSIST_CONTEXT";
1207
Jim Miller07994402012-05-02 14:22:27 -07001208 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001209 * Activity Action: List all available applications
1210 * <p>Input: Nothing.
1211 * <p>Output: nothing.
1212 */
1213 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1214 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1215 /**
1216 * Activity Action: Show settings for choosing wallpaper
1217 * <p>Input: Nothing.
1218 * <p>Output: Nothing.
1219 */
1220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1221 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1222
1223 /**
1224 * Activity Action: Show activity for reporting a bug.
1225 * <p>Input: Nothing.
1226 * <p>Output: Nothing.
1227 */
1228 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1229 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1230
1231 /**
1232 * Activity Action: Main entry point for factory tests. Only used when
1233 * the device is booting in factory test node. The implementing package
1234 * must be installed in the system image.
1235 * <p>Input: nothing
1236 * <p>Output: nothing
1237 */
1238 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1239
1240 /**
1241 * Activity Action: The user pressed the "call" button to go to the dialer
1242 * or other appropriate UI for placing a call.
1243 * <p>Input: Nothing.
1244 * <p>Output: Nothing.
1245 */
1246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1247 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1248
1249 /**
1250 * Activity Action: Start Voice Command.
1251 * <p>Input: Nothing.
1252 * <p>Output: Nothing.
1253 */
1254 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1255 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001256
1257 /**
1258 * Activity Action: Start action associated with long pressing on the
1259 * search key.
1260 * <p>Input: Nothing.
1261 * <p>Output: Nothing.
1262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001265
Jacek Surazski86b6c532009-05-13 14:38:28 +02001266 /**
1267 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1268 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001269 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001270 * <p>Input: No data is specified. The bug report is passed in using
1271 * an {@link #EXTRA_BUG_REPORT} field.
1272 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001273 *
1274 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001275 */
1276 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1277 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001278
1279 /**
1280 * Activity Action: Show power usage information to the user.
1281 * <p>Input: Nothing.
1282 * <p>Output: Nothing.
1283 */
1284 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1285 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001286
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001287 /**
1288 * Activity Action: Setup wizard to launch after a platform update. This
1289 * activity should have a string meta-data field associated with it,
1290 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1291 * the platform for setup. The activity will be launched only if
1292 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1293 * same value.
1294 * <p>Input: Nothing.
1295 * <p>Output: Nothing.
1296 * @hide
1297 */
1298 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1299 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001300
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001301 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001302 * Activity Action: Show settings for managing network data usage of a
1303 * specific application. Applications should define an activity that offers
1304 * options to control data usage.
1305 */
1306 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1307 public static final String ACTION_MANAGE_NETWORK_USAGE =
1308 "android.intent.action.MANAGE_NETWORK_USAGE";
1309
1310 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001311 * Activity Action: Launch application installer.
1312 * <p>
1313 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001314 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1315 * you can also use "package:<package-name>" to install an application for the
1316 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001317 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1318 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1319 * <p>
1320 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1321 * succeeded.
1322 *
1323 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1324 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1325 * @see #EXTRA_RETURN_RESULT
1326 */
1327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1328 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1329
1330 /**
1331 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1332 * package. Specifies the installer package name; this package will receive the
1333 * {@link #ACTION_APP_ERROR} intent.
1334 */
1335 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1336 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1337
1338 /**
1339 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1340 * package. Specifies that the application being installed should not be
1341 * treated as coming from an unknown source, but as coming from the app
1342 * invoking the Intent. For this to work you must start the installer with
1343 * startActivityForResult().
1344 */
1345 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1346 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1347
1348 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001349 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1350 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001351 * data field originated from.
1352 */
rich cannings706e8ba2012-08-20 13:20:14 -07001353 public static final String EXTRA_ORIGINATING_URI
1354 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001355
1356 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001357 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1358 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1359 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001360 */
1361 public static final String EXTRA_REFERRER
1362 = "android.intent.extra.REFERRER";
1363
1364 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001365 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1366 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1367 * @hide
1368 */
1369 public static final String EXTRA_ORIGINATING_UID
1370 = "android.intent.extra.ORIGINATING_UID";
1371
1372 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001373 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1374 * package. Tells the installer UI to skip the confirmation with the user
1375 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001376 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1377 * will no longer show an interstitial message about updating existing
1378 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001379 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001380 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001381 public static final String EXTRA_ALLOW_REPLACE
1382 = "android.intent.extra.ALLOW_REPLACE";
1383
1384 /**
1385 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1386 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1387 * return to the application the result code of the install/uninstall. The returned result
1388 * code will be {@link android.app.Activity#RESULT_OK} on success or
1389 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1390 */
1391 public static final String EXTRA_RETURN_RESULT
1392 = "android.intent.extra.RETURN_RESULT";
1393
1394 /**
1395 * Package manager install result code. @hide because result codes are not
1396 * yet ready to be exposed.
1397 */
1398 public static final String EXTRA_INSTALL_RESULT
1399 = "android.intent.extra.INSTALL_RESULT";
1400
1401 /**
1402 * Activity Action: Launch application uninstaller.
1403 * <p>
1404 * Input: The data must be a package: URI whose scheme specific part is
1405 * the package name of the current installed package to be uninstalled.
1406 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1407 * <p>
1408 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1409 * succeeded.
1410 */
1411 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1412 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1413
1414 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001415 * Specify whether the package should be uninstalled for all users.
1416 * @hide because these should not be part of normal application flow.
1417 */
1418 public static final String EXTRA_UNINSTALL_ALL_USERS
1419 = "android.intent.extra.UNINSTALL_ALL_USERS";
1420
1421 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001422 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1423 * describing the last run version of the platform that was setup.
1424 * @hide
1425 */
1426 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1427
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001428 // ---------------------------------------------------------------------
1429 // ---------------------------------------------------------------------
1430 // Standard intent broadcast actions (see action variable).
1431
1432 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001433 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1434 * <p>
1435 * For historical reasons, the name of this broadcast action refers to the power
1436 * state of the screen but it is actually sent in response to changes in the
1437 * overall interactive state of the device.
1438 * </p><p>
1439 * This broadcast is sent when the device becomes non-interactive which may have
1440 * nothing to do with the screen turning off. To determine the
1441 * actual state of the screen, use {@link android.view.Display#getState}.
1442 * </p><p>
1443 * See {@link android.os.PowerManager#isInteractive} for details.
1444 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001445 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001446 * <p class="note">This is a protected intent that can only be sent
1447 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001448 */
1449 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1450 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001451
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001452 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001453 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1454 * <p>
1455 * For historical reasons, the name of this broadcast action refers to the power
1456 * state of the screen but it is actually sent in response to changes in the
1457 * overall interactive state of the device.
1458 * </p><p>
1459 * This broadcast is sent when the device becomes interactive which may have
1460 * nothing to do with the screen turning on. To determine the
1461 * actual state of the screen, use {@link android.view.Display#getState}.
1462 * </p><p>
1463 * See {@link android.os.PowerManager#isInteractive} for details.
1464 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001465 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001466 * <p class="note">This is a protected intent that can only be sent
1467 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001468 */
1469 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1470 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001471
1472 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001473 * Broadcast Action: Sent after the system stops dreaming.
1474 *
1475 * <p class="note">This is a protected intent that can only be sent by the system.
1476 * It is only sent to registered receivers.</p>
1477 */
1478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1479 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1480
1481 /**
1482 * Broadcast Action: Sent after the system starts dreaming.
1483 *
1484 * <p class="note">This is a protected intent that can only be sent by the system.
1485 * It is only sent to registered receivers.</p>
1486 */
1487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1488 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1489
1490 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001491 * 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 -07001492 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001493 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001494 * <p class="note">This is a protected intent that can only be sent
1495 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001498 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001499
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001500 /**
1501 * Broadcast Action: The current time has changed. Sent every
1502 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001503 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001504 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1505 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001506 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001507 * <p class="note">This is a protected intent that can only be sent
1508 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1512 /**
1513 * Broadcast Action: The time was set.
1514 */
1515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1516 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1517 /**
1518 * Broadcast Action: The date has changed.
1519 */
1520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1521 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1522 /**
1523 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1524 * <ul>
1525 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1526 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001527 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001528 * <p class="note">This is a protected intent that can only be sent
1529 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001530 */
1531 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1532 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1533 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001534 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1535 * DNS entries should be tossed.
1536 * @hide
1537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1540 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001541 * Alarm Changed Action: This is broadcast when the AlarmClock
1542 * application's alarm is set or unset. It is used by the
1543 * AlarmClock application and the StatusBar service.
1544 * @hide
1545 */
1546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1547 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1548 /**
1549 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1550 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1551 * @hide
1552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_SYNC_STATE_CHANGED
1555 = "android.intent.action.SYNC_STATE_CHANGED";
1556 /**
1557 * Broadcast Action: This is broadcast once, after the system has finished
1558 * booting. It can be used to perform application-specific initialization,
1559 * such as installing alarms. You must hold the
1560 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1561 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001562 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001563 * <p class="note">This is a protected intent that can only be sent
1564 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001565 */
1566 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1567 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1568 /**
1569 * Broadcast Action: This is broadcast when a user action should request a
1570 * temporary system dialog to dismiss. Some examples of temporary system
1571 * dialogs are the notification window-shade and the recent tasks dialog.
1572 */
1573 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1574 /**
1575 * Broadcast Action: Trigger the download and eventual installation
1576 * of a package.
1577 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001578 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001579 * <p class="note">This is a protected intent that can only be sent
1580 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001581 *
1582 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001583 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001584 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1586 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1587 /**
1588 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001589 * device. The data contains the name of the package. Note that the
1590 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001591 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001592 * <ul>
1593 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1594 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1595 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1596 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001597 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001598 * <p class="note">This is a protected intent that can only be sent
1599 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001600 */
1601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1602 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1603 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001604 * Broadcast Action: A new version of an application package has been
1605 * installed, replacing an existing version that was previously installed.
1606 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001607 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001608 * <ul>
1609 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1610 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001611 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001612 * <p class="note">This is a protected intent that can only be sent
1613 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001614 */
1615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1616 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1617 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001618 * Broadcast Action: A new version of your application has been installed
1619 * over an existing one. This is only sent to the application that was
1620 * replaced. It does not contain any additional data; to receive it, just
1621 * use an intent filter for this action.
1622 *
1623 * <p class="note">This is a protected intent that can only be sent
1624 * by the system.
1625 */
1626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1627 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1628 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001629 * Broadcast Action: An existing application package has been removed from
1630 * the device. The data contains the name of the package. The package
1631 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001632 * <ul>
1633 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1634 * to the package.
1635 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1636 * application -- data and code -- is being removed.
1637 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1638 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1639 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001640 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001641 * <p class="note">This is a protected intent that can only be sent
1642 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001643 */
1644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1645 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1646 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001647 * Broadcast Action: An existing application package has been completely
1648 * removed from the device. The data contains the name of the package.
1649 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1650 * {@link #EXTRA_DATA_REMOVED} is true and
1651 * {@link #EXTRA_REPLACING} is false of that broadcast.
1652 *
1653 * <ul>
1654 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1655 * to the package.
1656 * </ul>
1657 *
1658 * <p class="note">This is a protected intent that can only be sent
1659 * by the system.
1660 */
1661 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1662 public static final String ACTION_PACKAGE_FULLY_REMOVED
1663 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1664 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001665 * Broadcast Action: An existing application package has been changed (e.g.
1666 * a component has been enabled or disabled). The data contains the name of
1667 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001668 * <ul>
1669 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001670 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001671 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001672 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1673 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001674 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001675 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001676 * <p class="note">This is a protected intent that can only be sent
1677 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001678 */
1679 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1680 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1681 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001682 * @hide
1683 * Broadcast Action: Ask system services if there is any reason to
1684 * restart the given package. The data contains the name of the
1685 * package.
1686 * <ul>
1687 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1688 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1689 * </ul>
1690 *
1691 * <p class="note">This is a protected intent that can only be sent
1692 * by the system.
1693 */
1694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1695 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1696 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001697 * Broadcast Action: The user has restarted a package, and all of its
1698 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001699 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001700 * be removed. Note that the restarted package does <em>not</em>
1701 * receive this broadcast.
1702 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001703 * <ul>
1704 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1705 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001706 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001707 * <p class="note">This is a protected intent that can only be sent
1708 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001709 */
1710 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1711 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1712 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001713 * Broadcast Action: The user has cleared the data of a package. This should
1714 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001715 * its persistent data is erased and this broadcast sent.
1716 * Note that the cleared package does <em>not</em>
1717 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001718 * <ul>
1719 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1720 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001721 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001722 * <p class="note">This is a protected intent that can only be sent
1723 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001724 */
1725 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1726 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1727 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001728 * Broadcast Action: A user ID has been removed from the system. The user
1729 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001730 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1735 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001736
1737 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001738 * Broadcast Action: Sent to the installer package of an application
1739 * when that application is first launched (that is the first time it
1740 * is moved out of the stopped state). The data contains the name of the package.
1741 *
1742 * <p class="note">This is a protected intent that can only be sent
1743 * by the system.
1744 */
1745 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1746 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1747
1748 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001749 * Broadcast Action: Sent to the system package verifier when a package
1750 * needs to be verified. The data contains the package URI.
1751 * <p class="note">
1752 * This is a protected intent that can only be sent by the system.
1753 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001754 */
1755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1756 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1757
1758 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001759 * Broadcast Action: Sent to the system package verifier when a package is
1760 * verified. The data contains the package URI.
1761 * <p class="note">
1762 * This is a protected intent that can only be sent by the system.
1763 */
1764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1765 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1766
1767 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001768 * Broadcast Action: Resources for a set of packages (which were
1769 * previously unavailable) are currently
1770 * available since the media on which they exist is available.
1771 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1772 * list of packages whose availability changed.
1773 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1774 * list of uids of packages whose availability changed.
1775 * Note that the
1776 * packages in this list do <em>not</em> receive this broadcast.
1777 * The specified set of packages are now available on the system.
1778 * <p>Includes the following extras:
1779 * <ul>
1780 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1781 * whose resources(were previously unavailable) are currently available.
1782 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1783 * packages whose resources(were previously unavailable)
1784 * are currently available.
1785 * </ul>
1786 *
1787 * <p class="note">This is a protected intent that can only be sent
1788 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001789 */
1790 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001791 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1792 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001793
1794 /**
1795 * Broadcast Action: Resources for a set of packages are currently
1796 * unavailable since the media on which they exist is unavailable.
1797 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1798 * list of packages whose availability changed.
1799 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1800 * list of uids of packages whose availability changed.
1801 * The specified set of packages can no longer be
1802 * launched and are practically unavailable on the system.
1803 * <p>Inclues the following extras:
1804 * <ul>
1805 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1806 * whose resources are no longer available.
1807 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1808 * whose resources are no longer available.
1809 * </ul>
1810 *
1811 * <p class="note">This is a protected intent that can only be sent
1812 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001815 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001816 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001817
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 /**
1819 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001820 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001821 * This should <em>only</em> be used to determine when the wallpaper
1822 * has changed to show the new wallpaper to the user. You should certainly
1823 * never, in response to this, change the wallpaper or other attributes of
1824 * it such as the suggested size. That would be crazy, right? You'd cause
1825 * all kinds of loops, especially if other apps are doing similar things,
1826 * right? Of course. So please don't do this.
1827 *
1828 * @deprecated Modern applications should use
1829 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1830 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1831 * shown behind their UI, rather than watching for this broadcast and
1832 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001833 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001834 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1836 /**
1837 * Broadcast Action: The current device {@link android.content.res.Configuration}
1838 * (orientation, locale, etc) has changed. When such a change happens, the
1839 * UIs (view hierarchy) will need to be rebuilt based on this new
1840 * information; for the most part, applications don't need to worry about
1841 * this, because the system will take care of stopping and restarting the
1842 * application to make sure it sees the new changes. Some system code that
1843 * can not be restarted will need to watch for this action and handle it
1844 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001845 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001846 * <p class="note">
1847 * You can <em>not</em> receive this through components declared
1848 * in manifests, only by explicitly registering for it with
1849 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1850 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001851 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001852 * <p class="note">This is a protected intent that can only be sent
1853 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001854 *
1855 * @see android.content.res.Configuration
1856 */
1857 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1858 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1859 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001860 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001861 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001862 * <p class="note">This is a protected intent that can only be sent
1863 * by the system.
1864 */
1865 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1866 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1867 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001868 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1869 * charging state, level, and other information about the battery.
1870 * See {@link android.os.BatteryManager} for documentation on the
1871 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001872 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001873 * <p class="note">
1874 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001875 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001876 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001877 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1878 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1879 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1880 * broadcasts that are sent and can be received through manifest
1881 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001882 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001883 * <p class="note">This is a protected intent that can only be sent
1884 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001885 */
1886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1887 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1888 /**
1889 * Broadcast Action: Indicates low battery condition on the device.
1890 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001891 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001892 * <p class="note">This is a protected intent that can only be sent
1893 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001894 */
1895 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1896 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1897 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001898 * Broadcast Action: Indicates the battery is now okay after being low.
1899 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1900 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001901 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001902 * <p class="note">This is a protected intent that can only be sent
1903 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001904 */
1905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1906 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1907 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001908 * Broadcast Action: External power has been connected to the device.
1909 * This is intended for applications that wish to register specifically to this notification.
1910 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1911 * stay active to receive this notification. This action can be used to implement actions
1912 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001913 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001914 * <p class="note">This is a protected intent that can only be sent
1915 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001916 */
1917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001918 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001919 /**
1920 * Broadcast Action: External power has been removed from the device.
1921 * This is intended for applications that wish to register specifically to this notification.
1922 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1923 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001924 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001925 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001926 * <p class="note">This is a protected intent that can only be sent
1927 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001930 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001931 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001932 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001933 * Broadcast Action: Device is shutting down.
1934 * This is broadcast when the device is being shut down (completely turned
1935 * off, not sleeping). Once the broadcast is complete, the final shutdown
1936 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001937 * to handle this, since the foreground activity will be paused as well.
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.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001941 * <p>May include the following extras:
1942 * <ul>
1943 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1944 * shutdown is only for userspace processes. If not set, assumed to be false.
1945 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001946 */
1947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001948 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001949 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001950 * Activity Action: Start this activity to request system shutdown.
1951 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1952 * to request confirmation from the user before shutting down.
1953 *
1954 * <p class="note">This is a protected intent that can only be sent
1955 * by the system.
1956 *
1957 * {@hide}
1958 */
1959 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1960 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001961 * Broadcast Action: A sticky broadcast that indicates low memory
1962 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001963 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001964 * <p class="note">This is a protected intent that can only be sent
1965 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001966 */
1967 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1968 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1969 /**
1970 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001971 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001972 * <p class="note">This is a protected intent that can only be sent
1973 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1976 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1977 /**
Jake Hambybb371632010-08-23 18:16:48 -07001978 * Broadcast Action: A sticky broadcast that indicates a memory full
1979 * condition on the device. This is intended for activities that want
1980 * to be able to fill the data partition completely, leaving only
1981 * enough free space to prevent system-wide SQLite failures.
1982 *
1983 * <p class="note">This is a protected intent that can only be sent
1984 * by the system.
1985 *
1986 * {@hide}
1987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1990 /**
1991 * Broadcast Action: Indicates memory full condition on the device
1992 * no longer exists.
1993 *
1994 * <p class="note">This is a protected intent that can only be sent
1995 * by the system.
1996 *
1997 * {@hide}
1998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2001 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002002 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2003 * and package management should be started.
2004 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2005 * notification.
2006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2009 /**
2010 * Broadcast Action: The device has entered USB Mass Storage mode.
2011 * This is used mainly for the USB Settings panel.
2012 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2013 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002014 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002015 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002016 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002017 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2018
2019 /**
2020 * Broadcast Action: The device has exited USB Mass Storage mode.
2021 * This is used mainly for the USB Settings panel.
2022 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2023 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002024 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002025 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002026 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002027 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2028
2029 /**
2030 * Broadcast Action: External media has been removed.
2031 * The path to the mount point for the removed media is contained in the Intent.mData field.
2032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2035
2036 /**
2037 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002038 * 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 -07002039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2042
2043 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002044 * Broadcast Action: External media is present, and being disk-checked
2045 * 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 -08002046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2049
2050 /**
2051 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2052 * 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 -08002053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2056
2057 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002058 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002059 * 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 -07002060 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2061 * media was mounted read only.
2062 */
2063 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2064 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2065
2066 /**
2067 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002068 * 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 -07002069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2072
2073 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002074 * Broadcast Action: External media is no longer being shared via USB mass storage.
2075 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2076 *
2077 * @hide
2078 */
2079 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2080
2081 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002082 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2083 * The path to the mount point for the removed media is contained in the Intent.mData field.
2084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2087
2088 /**
2089 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002090 * 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 -07002091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2094
2095 /**
2096 * Broadcast Action: User has expressed the desire to remove the external storage media.
2097 * Applications should close all files they have open within the mount point when they receive this intent.
2098 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2102
2103 /**
2104 * Broadcast Action: The media scanner has started scanning a directory.
2105 * The path to the directory being scanned is contained in the Intent.mData field.
2106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2109
2110 /**
2111 * Broadcast Action: The media scanner has finished scanning a directory.
2112 * The path to the scanned directory is contained in the Intent.mData field.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2116
2117 /**
2118 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2119 * The path to the file is contained in the Intent.mData field.
2120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2122 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2123
2124 /**
2125 * Broadcast Action: The "Media Button" was pressed. Includes a single
2126 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2127 * caused the broadcast.
2128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2131
2132 /**
2133 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2134 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2135 * caused the broadcast.
2136 */
2137 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2138 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2139
2140 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2141 // location; they are not general-purpose actions.
2142
2143 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002144 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002145 */
2146 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2147 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2148 "android.intent.action.GTALK_CONNECTED";
2149
2150 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002151 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2155 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002156
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002157 /**
2158 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002159 */
2160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2161 public static final String ACTION_INPUT_METHOD_CHANGED =
2162 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002163
2164 /**
2165 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2166 * more radios have been turned off or on. The intent will have the following extra value:</p>
2167 * <ul>
2168 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2169 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2170 * turned off</li>
2171 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002172 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002173 * <p class="note">This is a protected intent that can only be sent
2174 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002175 */
2176 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2177 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2178
2179 /**
2180 * Broadcast Action: Some content providers have parts of their namespace
2181 * where they publish new events or items that the user may be especially
2182 * interested in. For these things, they may broadcast this action when the
2183 * set of interesting items change.
2184 *
2185 * For example, GmailProvider sends this notification when the set of unread
2186 * mail in the inbox changes.
2187 *
2188 * <p>The data of the intent identifies which part of which provider
2189 * changed. When queried through the content resolver, the data URI will
2190 * return the data set in question.
2191 *
2192 * <p>The intent will have the following extra values:
2193 * <ul>
2194 * <li><em>count</em> - The number of items in the data set. This is the
2195 * same as the number of items in the cursor returned by querying the
2196 * data URI. </li>
2197 * </ul>
2198 *
2199 * This intent will be sent at boot (if the count is non-zero) and when the
2200 * data set changes. It is possible for the data set to change without the
2201 * count changing (for example, if a new unread message arrives in the same
2202 * sync operation in which a message is archived). The phone should still
2203 * ring/vibrate/etc as normal in this case.
2204 */
2205 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2206 public static final String ACTION_PROVIDER_CHANGED =
2207 "android.intent.action.PROVIDER_CHANGED";
2208
2209 /**
2210 * Broadcast Action: Wired Headset plugged in or unplugged.
2211 *
Matt Casey79867f52014-03-26 15:20:25 -07002212 * You <em>cannot</em> receive this through components declared
2213 * in manifests, only by explicitly registering for it with
2214 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2215 * Context.registerReceiver()}.
2216 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002217 * <p>The intent will have the following extra values:
2218 * <ul>
2219 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2220 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002221 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002222 * </ul>
2223 * </ul>
2224 */
2225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2226 public static final String ACTION_HEADSET_PLUG =
2227 "android.intent.action.HEADSET_PLUG";
2228
2229 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002230 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2231 *
2232 * <p>The intent will have the following extra values:
2233 * <ul>
2234 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2235 * <li><em>name</em> - Headset type, human readable string </li>
2236 * </ul>
2237 * </ul>
2238 * @hide
2239 */
2240 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002241 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2242 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002243
2244 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002245 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002246 *
2247 * <p>The intent will have the following extra values:
2248 * <ul>
2249 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2250 * <li><em>name</em> - Headset type, human readable string </li>
2251 * </ul>
2252 * </ul>
2253 * @hide
2254 */
2255 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002256 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2257 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002258
2259 /**
2260 * Broadcast Action: A HMDI cable was plugged or unplugged
2261 *
2262 * <p>The intent will have the following extra values:
2263 * <ul>
2264 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2265 * <li><em>name</em> - HDMI cable, human readable string </li>
2266 * </ul>
2267 * </ul>
2268 * @hide
2269 */
2270 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2271 public static final String ACTION_HDMI_AUDIO_PLUG =
2272 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002273
2274 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002275 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2276 *
2277 * <p>The intent will have the following extra values:
2278 * <ul>
2279 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2280 * <li><em>card</em> - ALSA card number (integer) </li>
2281 * <li><em>device</em> - ALSA device number (integer) </li>
2282 * </ul>
2283 * </ul>
2284 * @hide
2285 */
2286 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2287 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2288 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2289
2290 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002291 * Broadcast Action: A USB audio device was plugged in or unplugged.
2292 *
2293 * <p>The intent will have the following extra values:
2294 * <ul>
2295 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2296 * <li><em>card</em> - ALSA card number (integer) </li>
2297 * <li><em>device</em> - ALSA device number (integer) </li>
2298 * </ul>
2299 * </ul>
2300 * @hide
2301 */
2302 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2303 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2304 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2305
2306 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002307 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2308 * <ul>
2309 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2310 * </ul>
2311 *
2312 * <p class="note">This is a protected intent that can only be sent
2313 * by the system.
2314 *
2315 * @hide
2316 */
2317 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2318 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2319 = "android.intent.action.ADVANCED_SETTINGS";
2320
2321 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002322 * Broadcast Action: Sent after application restrictions are changed.
2323 *
2324 * <p class="note">This is a protected intent that can only be sent
2325 * by the system.</p>
2326 */
2327 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2328 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2329 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2330
2331 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002332 * Broadcast Action: An outgoing call is about to be placed.
2333 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002334 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002335 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002336 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002337 * the phone number originally intended to be dialed.</li>
2338 * </ul>
2339 * <p>Once the broadcast is finished, the resultData is used as the actual
2340 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002341 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002342 * outgoing call in turn: for example, a parental control application
2343 * might verify that the user is authorized to place the call at that
2344 * time, then a number-rewriting application might add an area code if
2345 * one was not specified.</p>
2346 * <p>For consistency, any receiver whose purpose is to prohibit phone
2347 * calls should have a priority of 0, to ensure it will see the final
2348 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002349 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002350 * should have a positive priority.
2351 * Negative priorities are reserved for the system for this broadcast;
2352 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002353 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2354 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002355 * <p>Emergency calls cannot be intercepted using this mechanism, and
2356 * other calls cannot be modified to call emergency numbers using this
2357 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002358 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2359 * call to use their own service instead. Those apps should first prevent
2360 * the call from being placed by setting resultData to <code>null</code>
2361 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002362 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2364 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002365 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002366 * <p class="note">This is a protected intent that can only be sent
2367 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002368 */
2369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2370 public static final String ACTION_NEW_OUTGOING_CALL =
2371 "android.intent.action.NEW_OUTGOING_CALL";
2372
2373 /**
2374 * Broadcast Action: Have the device reboot. This is only for use by
2375 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002376 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002377 * <p class="note">This is a protected intent that can only be sent
2378 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002379 */
2380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2381 public static final String ACTION_REBOOT =
2382 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002383
Wei Huang97ecc9c2009-05-11 17:44:20 -07002384 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002385 * Broadcast Action: A sticky broadcast for changes in the physical
2386 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002387 *
2388 * <p>The intent will have the following extra values:
2389 * <ul>
2390 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002391 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002392 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002393 * <p>This is intended for monitoring the current physical dock state.
2394 * See {@link android.app.UiModeManager} for the normal API dealing with
2395 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002396 */
2397 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2398 public static final String ACTION_DOCK_EVENT =
2399 "android.intent.action.DOCK_EVENT";
2400
2401 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002402 * Broadcast Action: A broadcast when idle maintenance can be started.
2403 * This means that the user is not interacting with the device and is
2404 * not expected to do so soon. Typical use of the idle maintenance is
2405 * to perform somehow expensive tasks that can be postponed at a moment
2406 * when they will not degrade user experience.
2407 * <p>
2408 * <p class="note">In order to keep the device responsive in case of an
2409 * unexpected user interaction, implementations of a maintenance task
2410 * should be interruptible. In such a scenario a broadcast with action
2411 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2412 * should not do the maintenance work in
2413 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2414 * maintenance service by {@link Context#startService(Intent)}. Also
2415 * you should hold a wake lock while your maintenance service is running
2416 * to prevent the device going to sleep.
2417 * </p>
2418 * <p>
2419 * <p class="note">This is a protected intent that can only be sent by
2420 * the system.
2421 * </p>
2422 *
2423 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002424 *
2425 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002426 */
2427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2428 public static final String ACTION_IDLE_MAINTENANCE_START =
2429 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2430
2431 /**
2432 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2433 * This means that the user was not interacting with the device as a result
2434 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2435 * was sent and now the user started interacting with the device. Typical
2436 * use of the idle maintenance is to perform somehow expensive tasks that
2437 * can be postponed at a moment when they will not degrade user experience.
2438 * <p>
2439 * <p class="note">In order to keep the device responsive in case of an
2440 * unexpected user interaction, implementations of a maintenance task
2441 * should be interruptible. Hence, on receiving a broadcast with this
2442 * action, the maintenance task should be interrupted as soon as possible.
2443 * In other words, you should not do the maintenance work in
2444 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2445 * maintenance service that was started on receiving of
2446 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2447 * lock you acquired when your maintenance service started.
2448 * </p>
2449 * <p class="note">This is a protected intent that can only be sent
2450 * by the system.
2451 *
2452 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002453 *
2454 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002455 */
2456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2457 public static final String ACTION_IDLE_MAINTENANCE_END =
2458 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2459
2460 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002461 * Broadcast Action: a remote intent is to be broadcasted.
2462 *
2463 * A remote intent is used for remote RPC between devices. The remote intent
2464 * is serialized and sent from one device to another device. The receiving
2465 * device parses the remote intent and broadcasts it. Note that anyone can
2466 * broadcast a remote intent. However, if the intent receiver of the remote intent
2467 * does not trust intent broadcasts from arbitrary intent senders, it should require
2468 * the sender to hold certain permissions so only trusted sender's broadcast will be
2469 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002470 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002471 */
2472 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002473 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002474
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002475 /**
2476 * Broadcast Action: hook for permforming cleanup after a system update.
2477 *
2478 * The broadcast is sent when the system is booting, before the
2479 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2480 * image. A receiver for this should do its work and then disable itself
2481 * so that it does not get run again at the next boot.
2482 * @hide
2483 */
2484 public static final String ACTION_PRE_BOOT_COMPLETED =
2485 "android.intent.action.PRE_BOOT_COMPLETED";
2486
Amith Yamasani13593602012-03-22 16:16:17 -07002487 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002488 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002489 * on restricted users. The broadcast intent contains an extra
2490 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2491 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2492 * String[] depending on the restriction type.<p/>
2493 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002494 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2495 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2496 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002497 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2498 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002499 * @see RestrictionEntry
2500 */
2501 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2502 "android.intent.action.GET_RESTRICTION_ENTRIES";
2503
2504 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002505 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002506 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002507 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2508 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2509 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002510 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2511 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2512 * challenge.<p/>
2513 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002514 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002515 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002516 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2517 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002518
2519 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002520 * Sent the first time a user is starting, to allow system apps to
2521 * perform one time initialization. (This will not be seen by third
2522 * party applications because a newly initialized user does not have any
2523 * third party applications installed for it.) This is sent early in
2524 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002525 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2526 * broadcast, since it is part of a visible user interaction; be as quick
2527 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002528 */
2529 public static final String ACTION_USER_INITIALIZE =
2530 "android.intent.action.USER_INITIALIZE";
2531
2532 /**
2533 * Sent when a user switch is happening, causing the process's user to be
2534 * brought to the foreground. This is only sent to receivers registered
2535 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2536 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002537 * foreground. This is sent as a foreground
2538 * broadcast, since it is part of a visible user interaction; be as quick
2539 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002540 */
2541 public static final String ACTION_USER_FOREGROUND =
2542 "android.intent.action.USER_FOREGROUND";
2543
2544 /**
2545 * Sent when a user switch is happening, causing the process's user to be
2546 * sent to the background. This is only sent to receivers registered
2547 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2548 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002549 * background. This is sent as a foreground
2550 * broadcast, since it is part of a visible user interaction; be as quick
2551 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002552 */
2553 public static final String ACTION_USER_BACKGROUND =
2554 "android.intent.action.USER_BACKGROUND";
2555
2556 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002557 * Broadcast sent to the system when a user is added. Carries an extra
2558 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2559 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002560 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002561 * @hide
2562 */
2563 public static final String ACTION_USER_ADDED =
2564 "android.intent.action.USER_ADDED";
2565
2566 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002567 * Broadcast sent by the system when a user is started. Carries an extra
2568 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002569 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002570 * that has been started. This is sent as a foreground
2571 * broadcast, since it is part of a visible user interaction; be as quick
2572 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002573 * @hide
2574 */
2575 public static final String ACTION_USER_STARTED =
2576 "android.intent.action.USER_STARTED";
2577
2578 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002579 * Broadcast sent when a user is in the process of starting. Carries an extra
2580 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2581 * sent to registered receivers, not manifest receivers. It is sent to all
2582 * users (including the one that is being started). You must hold
2583 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2584 * this broadcast. This is sent as a background broadcast, since
2585 * its result is not part of the primary UX flow; to safely keep track of
2586 * started/stopped state of a user you can use this in conjunction with
2587 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2588 * other user state broadcasts since those are foreground broadcasts so can
2589 * execute in a different order.
2590 * @hide
2591 */
2592 public static final String ACTION_USER_STARTING =
2593 "android.intent.action.USER_STARTING";
2594
2595 /**
2596 * Broadcast sent when a user is going to be stopped. Carries an extra
2597 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2598 * sent to registered receivers, not manifest receivers. It is sent to all
2599 * users (including the one that is being stopped). You must hold
2600 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2601 * this broadcast. The user will not stop until all receivers have
2602 * handled the broadcast. This is sent as a background broadcast, since
2603 * its result is not part of the primary UX flow; to safely keep track of
2604 * started/stopped state of a user you can use this in conjunction with
2605 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2606 * other user state broadcasts since those are foreground broadcasts so can
2607 * execute in a different order.
2608 * @hide
2609 */
2610 public static final String ACTION_USER_STOPPING =
2611 "android.intent.action.USER_STOPPING";
2612
2613 /**
2614 * Broadcast sent to the system when a user is stopped. Carries an extra
2615 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2616 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2617 * specific package. This is only sent to registered receivers, not manifest
2618 * receivers. It is sent to all running users <em>except</em> the one that
2619 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002620 * @hide
2621 */
2622 public static final String ACTION_USER_STOPPED =
2623 "android.intent.action.USER_STOPPED";
2624
2625 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002626 * 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 -07002627 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002628 * one that has been removed. The user will not be completely removed until all receivers have
2629 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002630 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002631 * @hide
2632 */
2633 public static final String ACTION_USER_REMOVED =
2634 "android.intent.action.USER_REMOVED";
2635
2636 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002637 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002638 * the userHandle of the user to become the current one. This is only sent to
2639 * registered receivers, not manifest receivers. It is sent to all running users.
2640 * You must hold
2641 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002642 * @hide
2643 */
2644 public static final String ACTION_USER_SWITCHED =
2645 "android.intent.action.USER_SWITCHED";
2646
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002647 /**
2648 * Broadcast sent to the system when a user's information changes. Carries an extra
2649 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002650 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002651 * @hide
2652 */
2653 public static final String ACTION_USER_INFO_CHANGED =
2654 "android.intent.action.USER_INFO_CHANGED";
2655
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002656 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002657 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2658 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002659 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2660 * that need to display merged content across both primary and managed profiles need to
2661 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002662 * not manifest receivers.
2663 */
2664 public static final String ACTION_MANAGED_PROFILE_ADDED =
2665 "android.intent.action.MANAGED_PROFILE_ADDED";
2666
2667 /**
2668 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002669 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2670 * Only applications (for example Launchers) that need to display merged content across both
2671 * primary and managed profiles need to worry about this broadcast. This is only sent to
2672 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002673 */
2674 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2675 "android.intent.action.MANAGED_PROFILE_REMOVED";
2676
2677 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002678 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2679 */
2680 public static final String ACTION_QUICK_CLOCK =
2681 "android.intent.action.QUICK_CLOCK";
2682
Michael Wright0087a142013-02-05 16:29:39 -08002683 /**
2684 * Broadcast Action: This is broadcast when a user action should request the
2685 * brightness setting dialog.
2686 * @hide
2687 */
2688 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2689 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2690
Justin Kohd378ad72013-04-01 12:18:26 -07002691 /**
2692 * Broadcast Action: A global button was pressed. Includes a single
2693 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2694 * caused the broadcast.
2695 * @hide
2696 */
2697 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2698
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002699 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002700 * Activity Action: Allow the user to select and return one or more existing
2701 * documents. When invoked, the system will display the various
2702 * {@link DocumentsProvider} instances installed on the device, letting the
2703 * user interactively navigate through them. These documents include local
2704 * media, such as photos and video, and documents provided by installed
2705 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002706 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002707 * Each document is represented as a {@code content://} URI backed by a
2708 * {@link DocumentsProvider}, which can be opened as a stream with
2709 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2710 * {@link android.provider.DocumentsContract.Document} metadata.
2711 * <p>
2712 * All selected documents are returned to the calling application with
2713 * persistable read and write permission grants. If you want to maintain
2714 * access to the documents across device reboots, you need to explicitly
2715 * take the persistable permissions using
2716 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2717 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002718 * Callers must indicate the acceptable document MIME types through
2719 * {@link #setType(String)}. For example, to select photos, use
2720 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2721 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2722 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002723 * <p>
2724 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002725 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2726 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002727 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002728 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2729 * returned URIs can be opened with
2730 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002731 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002732 * Output: The URI of the item that was picked, returned in
2733 * {@link #getData()}. This must be a {@code content://} URI so that any
2734 * receiver can access it. If multiple documents were selected, they are
2735 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002736 *
2737 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002738 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002739 * @see #ACTION_CREATE_DOCUMENT
2740 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002741 */
2742 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2743 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2744
2745 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002746 * Activity Action: Allow the user to create a new document. When invoked,
2747 * the system will display the various {@link DocumentsProvider} instances
2748 * installed on the device, letting the user navigate through them. The
2749 * returned document may be a newly created document with no content, or it
2750 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002751 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002752 * Each document is represented as a {@code content://} URI backed by a
2753 * {@link DocumentsProvider}, which can be opened as a stream with
2754 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2755 * {@link android.provider.DocumentsContract.Document} metadata.
2756 * <p>
2757 * Callers must indicate the concrete MIME type of the document being
2758 * created by setting {@link #setType(String)}. This MIME type cannot be
2759 * changed after the document is created.
2760 * <p>
2761 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2762 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002763 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002764 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2765 * returned URIs can be opened with
2766 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002767 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002768 * Output: The URI of the item that was created. This must be a
2769 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002770 *
2771 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002772 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002773 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002774 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002775 */
2776 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2777 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2778
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002779 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002780 * Activity Action: Allow the user to pick a directory subtree. When
2781 * invoked, the system will display the various {@link DocumentsProvider}
2782 * instances installed on the device, letting the user navigate through
2783 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002784 * <p>
2785 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002786 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2787 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2788 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002789 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002790 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002791 *
2792 * @see DocumentsContract
2793 */
2794 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002795 public static final String
2796 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002797
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002798 // ---------------------------------------------------------------------
2799 // ---------------------------------------------------------------------
2800 // Standard intent categories (see addCategory()).
2801
2802 /**
2803 * Set if the activity should be an option for the default action
2804 * (center press) to perform on a piece of data. Setting this will
2805 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002806 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002807 * Intent when initiating an action -- it is for use in intent filters
2808 * specified in packages.
2809 */
2810 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2811 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2812 /**
2813 * Activities that can be safely invoked from a browser must support this
2814 * category. For example, if the user is viewing a web page or an e-mail
2815 * and clicks on a link in the text, the Intent generated execute that
2816 * link will require the BROWSABLE category, so that only activities
2817 * supporting this category will be considered as possible actions. By
2818 * supporting this category, you are promising that there is nothing
2819 * damaging (without user intervention) that can happen by invoking any
2820 * matching Intent.
2821 */
2822 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2823 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2824 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002825 * Categories for activities that can participate in voice interaction.
2826 * An activity that supports this category must be prepared to run with
2827 * no UI shown at all (though in some case it may have a UI shown), and
2828 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2829 */
2830 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2831 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2832 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002833 * Set if the activity should be considered as an alternative action to
2834 * the data the user is currently viewing. See also
2835 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2836 * applies to the selection in a list of items.
2837 *
2838 * <p>Supporting this category means that you would like your activity to be
2839 * displayed in the set of alternative things the user can do, usually as
2840 * part of the current activity's options menu. You will usually want to
2841 * include a specific label in the &lt;intent-filter&gt; of this action
2842 * describing to the user what it does.
2843 *
2844 * <p>The action of IntentFilter with this category is important in that it
2845 * describes the specific action the target will perform. This generally
2846 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2847 * a specific name such as "com.android.camera.action.CROP. Only one
2848 * alternative of any particular action will be shown to the user, so using
2849 * a specific action like this makes sure that your alternative will be
2850 * displayed while also allowing other applications to provide their own
2851 * overrides of that particular action.
2852 */
2853 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2854 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2855 /**
2856 * Set if the activity should be considered as an alternative selection
2857 * action to the data the user has currently selected. This is like
2858 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2859 * of items from which the user can select, giving them alternatives to the
2860 * default action that will be performed on it.
2861 */
2862 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2863 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2864 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002865 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002866 */
2867 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2868 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2869 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870 * Should be displayed in the top-level launcher.
2871 */
2872 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2873 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2874 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002875 * Indicates an activity optimized for Leanback mode, and that should
2876 * be displayed in the Leanback launcher.
2877 */
2878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2879 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2880 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002881 * Provides information about the package it is in; typically used if
2882 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2883 * a front-door to the user without having to be shown in the all apps list.
2884 */
2885 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2886 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2887 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002888 * This is the home activity, that is the first activity that is displayed
2889 * when the device boots.
2890 */
2891 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2892 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2893 /**
2894 * This activity is a preference panel.
2895 */
2896 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2897 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2898 /**
2899 * This activity is a development preference panel.
2900 */
2901 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2902 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2903 /**
2904 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002905 */
2906 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2907 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2908 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002909 * This activity allows the user to browse and download new applications.
2910 */
2911 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2912 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2913 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002914 * This activity may be exercised by the monkey or other automated test tools.
2915 */
2916 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2917 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2918 /**
2919 * To be used as a test (not part of the normal user experience).
2920 */
2921 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2922 /**
2923 * To be used as a unit test (run through the Test Harness).
2924 */
2925 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2926 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002927 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002928 * experience).
2929 */
2930 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002931
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002932 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002933 * Used to indicate that an intent only wants URIs that can be opened with
2934 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2935 * must support at least the columns defined in {@link OpenableColumns} when
2936 * queried.
2937 *
2938 * @see #ACTION_GET_CONTENT
2939 * @see #ACTION_OPEN_DOCUMENT
2940 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002941 */
2942 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2943 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2944
2945 /**
2946 * To be used as code under test for framework instrumentation tests.
2947 */
2948 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2949 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002950 /**
2951 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002952 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2953 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002954 */
2955 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2956 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2957 /**
2958 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002959 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2960 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002961 */
2962 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2963 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002964 /**
2965 * An activity to run when device is inserted into a analog (low end) dock.
2966 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2967 * information, see {@link android.app.UiModeManager}.
2968 */
2969 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2970 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2971
2972 /**
2973 * An activity to run when device is inserted into a digital (high end) dock.
2974 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2975 * information, see {@link android.app.UiModeManager}.
2976 */
2977 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2978 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002979
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002980 /**
2981 * Used to indicate that the activity can be used in a car environment.
2982 */
2983 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2984 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2985
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002986 // ---------------------------------------------------------------------
2987 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002988 // Application launch intent categories (see addCategory()).
2989
2990 /**
2991 * Used with {@link #ACTION_MAIN} to launch the browser application.
2992 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002993 * <p>NOTE: This should not be used as the primary key of an Intent,
2994 * since it will not result in the app launching with the correct
2995 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002996 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002997 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002998 */
2999 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3000 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3001
3002 /**
3003 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3004 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003005 * <p>NOTE: This should not be used as the primary key of an Intent,
3006 * since it will not result in the app launching with the correct
3007 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003008 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003009 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003010 */
3011 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3012 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3013
3014 /**
3015 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3016 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003017 * <p>NOTE: This should not be used as the primary key of an Intent,
3018 * since it will not result in the app launching with the correct
3019 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003020 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003021 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003022 */
3023 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3024 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3025
3026 /**
3027 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3028 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003029 * <p>NOTE: This should not be used as the primary key of an Intent,
3030 * since it will not result in the app launching with the correct
3031 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003032 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003033 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003034 */
3035 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3036 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3037
3038 /**
3039 * Used with {@link #ACTION_MAIN} to launch the email application.
3040 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003041 * <p>NOTE: This should not be used as the primary key of an Intent,
3042 * since it will not result in the app launching with the correct
3043 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003044 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003045 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003046 */
3047 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3048 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3049
3050 /**
3051 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3052 * The activity should be able to view and manipulate image and video files
3053 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003054 * <p>NOTE: This should not be used as the primary key of an Intent,
3055 * since it will not result in the app launching with the correct
3056 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003057 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003058 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003059 */
3060 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3061 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3062
3063 /**
3064 * Used with {@link #ACTION_MAIN} to launch the maps application.
3065 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003066 * <p>NOTE: This should not be used as the primary key of an Intent,
3067 * since it will not result in the app launching with the correct
3068 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003069 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003070 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003071 */
3072 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3073 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3074
3075 /**
3076 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3077 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003078 * <p>NOTE: This should not be used as the primary key of an Intent,
3079 * since it will not result in the app launching with the correct
3080 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003081 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003082 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003083 */
3084 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3085 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3086
3087 /**
3088 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003089 * The activity should be able to play, browse, or manipulate music files
3090 * stored on the device.
3091 * <p>NOTE: This should not be used as the primary key of an Intent,
3092 * since it will not result in the app launching with the correct
3093 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003094 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003095 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003096 */
3097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3098 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3099
3100 // ---------------------------------------------------------------------
3101 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003102 // Standard extra data keys.
3103
3104 /**
3105 * The initial data to place in a newly created record. Use with
3106 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3107 * fields as would be given to the underlying ContentProvider.insert()
3108 * call.
3109 */
3110 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3111
3112 /**
3113 * A constant CharSequence that is associated with the Intent, used with
3114 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3115 * this may be a styled CharSequence, so you must use
3116 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3117 * retrieve it.
3118 */
3119 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3120
3121 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003122 * A constant String that is associated with the Intent, used with
3123 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3124 * as HTML formatted text. Note that you <em>must</em> also supply
3125 * {@link #EXTRA_TEXT}.
3126 */
3127 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3128
3129 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003130 * A content: URI holding a stream of data associated with the Intent,
3131 * used with {@link #ACTION_SEND} to supply the data being sent.
3132 */
3133 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3134
3135 /**
3136 * A String[] holding e-mail addresses that should be delivered to.
3137 */
3138 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3139
3140 /**
3141 * A String[] holding e-mail addresses that should be carbon copied.
3142 */
3143 public static final String EXTRA_CC = "android.intent.extra.CC";
3144
3145 /**
3146 * A String[] holding e-mail addresses that should be blind carbon copied.
3147 */
3148 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3149
3150 /**
3151 * A constant string holding the desired subject line of a message.
3152 */
3153 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3154
3155 /**
3156 * An Intent describing the choices you would like shown with
3157 * {@link #ACTION_PICK_ACTIVITY}.
3158 */
3159 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3160
3161 /**
3162 * A CharSequence dialog title to provide to the user when used with a
3163 * {@link #ACTION_CHOOSER}.
3164 */
3165 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3166
3167 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003168 * A Parcelable[] of {@link Intent} or
3169 * {@link android.content.pm.LabeledIntent} objects as set with
3170 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3171 * a the front of the list of choices, when shown to the user with a
3172 * {@link #ACTION_CHOOSER}.
3173 */
3174 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3175
3176 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003177 * A {@link android.view.KeyEvent} object containing the event that
3178 * triggered the creation of the Intent it is in.
3179 */
3180 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3181
3182 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003183 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3184 * before shutting down.
3185 *
3186 * {@hide}
3187 */
3188 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3189
3190 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003191 * 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 -07003192 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3193 * of restarting the application.
3194 */
3195 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3196
3197 /**
3198 * A String holding the phone number originally entered in
3199 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3200 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3201 */
3202 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003203
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003204 /**
3205 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3206 * intents to supply the uid the package had been assigned. Also an optional
3207 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3208 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3209 * purpose.
3210 */
3211 public static final String EXTRA_UID = "android.intent.extra.UID";
3212
3213 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003214 * @hide String array of package names.
3215 */
3216 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3217
3218 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003219 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3220 * intents to indicate whether this represents a full uninstall (removing
3221 * both the code and its data) or a partial uninstall (leaving its data,
3222 * implying that this is an update).
3223 */
3224 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003225
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003226 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003227 * @hide
3228 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3229 * intents to indicate that at this point the package has been removed for
3230 * all users on the device.
3231 */
3232 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3233 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3234
3235 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003236 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3237 * intents to indicate that this is a replacement of the package, so this
3238 * broadcast will immediately be followed by an add broadcast for a
3239 * different version of the same package.
3240 */
3241 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003242
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003243 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003244 * Used as an int extra field in {@link android.app.AlarmManager} intents
3245 * to tell the application being invoked how many pending alarms are being
3246 * delievered with the intent. For one-shot alarms this will always be 1.
3247 * For recurring alarms, this might be greater than 1 if the device was
3248 * asleep or powered off at the time an earlier alarm would have been
3249 * delivered.
3250 */
3251 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003252
Jacek Surazski86b6c532009-05-13 14:38:28 +02003253 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003254 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3255 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003256 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3257 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003258 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3259 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3260 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003261 */
3262 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3263
3264 /**
3265 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3266 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003267 */
3268 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3269
3270 /**
3271 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3272 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003273 */
3274 public static final int EXTRA_DOCK_STATE_DESK = 1;
3275
3276 /**
3277 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3278 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003279 */
3280 public static final int EXTRA_DOCK_STATE_CAR = 2;
3281
3282 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003283 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3284 * to represent that the phone is in a analog (low end) dock.
3285 */
3286 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3287
3288 /**
3289 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3290 * to represent that the phone is in a digital (high end) dock.
3291 */
3292 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3293
3294 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003295 * Boolean that can be supplied as meta-data with a dock activity, to
3296 * indicate that the dock should take over the home key when it is active.
3297 */
3298 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003299
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003300 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003301 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3302 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003303 */
3304 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3305
3306 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003307 * Used in the extra field in the remote intent. It's astring token passed with the
3308 * remote intent.
3309 */
3310 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3311 "android.intent.extra.remote_intent_token";
3312
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003313 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003314 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003315 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003316 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003317 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003318 "android.intent.extra.changed_component_name";
3319
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003320 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003321 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003322 * and contains a string array of all of the components that have changed. If
3323 * the state of the overall package has changed, then it will contain an entry
3324 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003325 */
3326 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3327 "android.intent.extra.changed_component_name_list";
3328
3329 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003330 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003331 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3332 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003333 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003334 */
3335 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3336 "android.intent.extra.changed_package_list";
3337
3338 /**
3339 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003340 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3341 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003342 * and contains an integer array of uids of all of the components
3343 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003344 */
3345 public static final String EXTRA_CHANGED_UID_LIST =
3346 "android.intent.extra.changed_uid_list";
3347
3348 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003349 * @hide
3350 * Magic extra system code can use when binding, to give a label for
3351 * who it is that has bound to a service. This is an integer giving
3352 * a framework string resource that can be displayed to the user.
3353 */
3354 public static final String EXTRA_CLIENT_LABEL =
3355 "android.intent.extra.client_label";
3356
3357 /**
3358 * @hide
3359 * Magic extra system code can use when binding, to give a PendingIntent object
3360 * that can be launched for the user to disable the system's use of this
3361 * service.
3362 */
3363 public static final String EXTRA_CLIENT_INTENT =
3364 "android.intent.extra.client_intent";
3365
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003366 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003367 * Extra used to indicate that an intent should only return data that is on
3368 * the local device. This is a boolean extra; the default is false. If true,
3369 * an implementation should only allow the user to select data that is
3370 * already on the device, not requiring it be downloaded from a remote
3371 * service when opened.
3372 *
3373 * @see #ACTION_GET_CONTENT
3374 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003375 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003376 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003377 */
3378 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003379 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003380
Amith Yamasani13593602012-03-22 16:16:17 -07003381 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003382 * Extra used to indicate that an intent can allow the user to select and
3383 * return multiple items. This is a boolean extra; the default is false. If
3384 * true, an implementation is allowed to present the user with a UI where
3385 * they can pick multiple items that are all returned to the caller. When
3386 * this happens, they should be returned as the {@link #getClipData()} part
3387 * of the result Intent.
3388 *
3389 * @see #ACTION_GET_CONTENT
3390 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003391 */
3392 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003393 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003394
3395 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003396 * The integer userHandle carried with broadcast intents related to addition, removal and
3397 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3398 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3399 *
Amith Yamasani13593602012-03-22 16:16:17 -07003400 * @hide
3401 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003402 public static final String EXTRA_USER_HANDLE =
3403 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003404
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003405 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003406 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3407 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3408 */
3409 public static final String EXTRA_USER =
3410 "android.intent.extra.user";
3411
3412 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003413 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003414 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3415 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003416 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003417 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3418
3419 /**
3420 * Extra sent in the intent to the BroadcastReceiver that handles
3421 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3422 * the restrictions as key/value pairs.
3423 */
3424 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3425 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003426
Amith Yamasani86118ba2013-03-28 14:33:16 -07003427 /**
3428 * Extra used in the response from a BroadcastReceiver that handles
3429 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3430 */
3431 public static final String EXTRA_RESTRICTIONS_INTENT =
3432 "android.intent.extra.restrictions_intent";
3433
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003434 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003435 * Extra used to communicate a set of acceptable MIME types. The type of the
3436 * extra is {@code String[]}. Values may be a combination of concrete MIME
3437 * types (such as "image/png") and/or partial MIME types (such as
3438 * "audio/*").
3439 *
3440 * @see #ACTION_GET_CONTENT
3441 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003442 */
3443 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3444
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003445 /**
3446 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3447 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003448 * When this is true, hardware devices can use this information to determine that
3449 * they shouldn't do a complete shutdown of their device since this is not a
3450 * complete shutdown down to the kernel, but only user space restarting.
3451 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003452 */
3453 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3454 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3455
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003456 /**
3457 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3458 * user has set their time format preferences to the 24 hour format.
3459 *
3460 * @hide for internal use only.
3461 */
3462 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3463 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3464
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003465 // ---------------------------------------------------------------------
3466 // ---------------------------------------------------------------------
3467 // Intent flags (see mFlags variable).
3468
Tor Norbyed9273d62013-05-30 15:59:53 -07003469 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003470 @IntDef(flag = true, value = {
3471 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3472 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003473 @Retention(RetentionPolicy.SOURCE)
3474 public @interface GrantUriMode {}
3475
Jeff Sharkey846318a2014-04-04 12:12:41 -07003476 /** @hide */
3477 @IntDef(flag = true, value = {
3478 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3479 @Retention(RetentionPolicy.SOURCE)
3480 public @interface AccessUriMode {}
3481
3482 /**
3483 * Test if given mode flags specify an access mode, which must be at least
3484 * read and/or write.
3485 *
3486 * @hide
3487 */
3488 public static boolean isAccessUriMode(int modeFlags) {
3489 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3490 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3491 }
3492
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003493 /**
3494 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003495 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003496 * specified in its ClipData. When applying to an Intent's ClipData,
3497 * all URIs as well as recursive traversals through data or other ClipData
3498 * in Intent items will be granted; only the grant flags of the top-level
3499 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003500 */
3501 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3502 /**
3503 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003504 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003505 * specified in its ClipData. When applying to an Intent's ClipData,
3506 * all URIs as well as recursive traversals through data or other ClipData
3507 * in Intent items will be granted; only the grant flags of the top-level
3508 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 */
3510 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3511 /**
3512 * Can be set by the caller to indicate that this Intent is coming from
3513 * a background operation, not from direct user interaction.
3514 */
3515 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3516 /**
3517 * A flag you can enable for debugging: when set, log messages will be
3518 * printed during the resolution of this intent to show you what has
3519 * been found to create the final resolved list.
3520 */
3521 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003522 /**
3523 * If set, this intent will not match any components in packages that
3524 * are currently stopped. If this is not set, then the default behavior
3525 * is to include such applications in the result.
3526 */
3527 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3528 /**
3529 * If set, this intent will always match any components in packages that
3530 * are currently stopped. This is the default behavior when
3531 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3532 * flags are set, this one wins (it allows overriding of exclude for
3533 * places where the framework may automatically set the exclude flag).
3534 */
3535 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536
3537 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003538 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003539 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003540 * persisted across device reboots until explicitly revoked with
3541 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3542 * grant for possible persisting; the receiving application must call
3543 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3544 * actually persist.
3545 *
3546 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3547 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3548 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003549 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003550 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003551 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003552
3553 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003554 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3555 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3556 * applies to any URI that is a prefix match against the original granted
3557 * URI. (Without this flag, the URI must match exactly for access to be
3558 * granted.) Another URI is considered a prefix match only when scheme,
3559 * authority, and all path segments defined by the prefix are an exact
3560 * match.
3561 */
3562 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3563
3564 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003565 * If set, the new activity is not kept in the history stack. As soon as
3566 * the user navigates away from it, the activity is finished. This may also
3567 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3568 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003569 */
3570 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3571 /**
3572 * If set, the activity will not be launched if it is already running
3573 * at the top of the history stack.
3574 */
3575 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3576 /**
3577 * If set, this activity will become the start of a new task on this
3578 * history stack. A task (from the activity that started it to the
3579 * next task activity) defines an atomic group of activities that the
3580 * user can move to. Tasks can be moved to the foreground and background;
3581 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003582 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003583 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3584 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003585 *
3586 * <p>This flag is generally used by activities that want
3587 * to present a "launcher" style behavior: they give the user a list of
3588 * separate things that can be done, which otherwise run completely
3589 * independently of the activity launching them.
3590 *
3591 * <p>When using this flag, if a task is already running for the activity
3592 * you are now starting, then a new activity will not be started; instead,
3593 * the current task will simply be brought to the front of the screen with
3594 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3595 * to disable this behavior.
3596 *
3597 * <p>This flag can not be used when the caller is requesting a result from
3598 * the activity being launched.
3599 */
3600 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3601 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003602 * This flag is used to create a new task and launch an activity into it.
3603 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3604 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3605 * search through existing tasks for ones matching this Intent. Only if no such
3606 * task is found would a new task be created. When paired with
3607 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3608 * the search for a matching task and unconditionally start a new task.
3609 *
3610 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3611 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003612 * top-level application launcher.</strong> Used in conjunction with
3613 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3614 * behavior of bringing an existing task to the foreground. When set,
3615 * a new task is <em>always</em> started to host the Activity for the
3616 * Intent, regardless of whether there is already an existing task running
3617 * the same thing.
3618 *
3619 * <p><strong>Because the default system does not include graphical task management,
3620 * you should not use this flag unless you provide some way for a user to
3621 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003622 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003623 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3624 * creating new document tasks.
3625 *
3626 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3627 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003628 *
Scott Main7aee61f2011-02-08 11:25:01 -08003629 * <p>See
3630 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3631 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003632 *
3633 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3634 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003635 */
3636 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3637 /**
3638 * If set, and the activity being launched is already running in the
3639 * current task, then instead of launching a new instance of that activity,
3640 * all of the other activities on top of it will be closed and this Intent
3641 * will be delivered to the (now on top) old activity as a new Intent.
3642 *
3643 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3644 * If D calls startActivity() with an Intent that resolves to the component
3645 * of activity B, then C and D will be finished and B receive the given
3646 * Intent, resulting in the stack now being: A, B.
3647 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003648 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003649 * either receive the new intent you are starting here in its
3650 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003651 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003652 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3653 * the same intent, then it will be finished and re-created; for all other
3654 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3655 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003656 *
3657 * <p>This launch mode can also be used to good effect in conjunction with
3658 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3659 * of a task, it will bring any currently running instance of that task
3660 * to the foreground, and then clear it to its root state. This is
3661 * especially useful, for example, when launching an activity from the
3662 * notification manager.
3663 *
Scott Main7aee61f2011-02-08 11:25:01 -08003664 * <p>See
3665 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3666 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003667 */
3668 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3669 /**
3670 * If set and this intent is being used to launch a new activity from an
3671 * existing one, then the reply target of the existing activity will be
3672 * transfered to the new activity. This way the new activity can call
3673 * {@link android.app.Activity#setResult} and have that result sent back to
3674 * the reply target of the original activity.
3675 */
3676 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3677 /**
3678 * If set and this intent is being used to launch a new activity from an
3679 * existing one, the current activity will not be counted as the top
3680 * activity for deciding whether the new intent should be delivered to
3681 * the top instead of starting a new one. The previous activity will
3682 * be used as the top, with the assumption being that the current activity
3683 * will finish itself immediately.
3684 */
3685 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3686 /**
3687 * If set, the new activity is not kept in the list of recently launched
3688 * activities.
3689 */
3690 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3691 /**
3692 * This flag is not normally set by application code, but set for you by
3693 * the system as described in the
3694 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3695 * launchMode} documentation for the singleTask mode.
3696 */
3697 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3698 /**
3699 * If set, and this activity is either being started in a new task or
3700 * bringing to the top an existing task, then it will be launched as
3701 * the front door of the task. This will result in the application of
3702 * any affinities needed to have that task in the proper state (either
3703 * moving activities to or from it), or simply resetting that task to
3704 * its initial state if needed.
3705 */
3706 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3707 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003708 * This flag is not normally set by application code, but set for you by
3709 * the system if this activity is being launched from history
3710 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003711 */
3712 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003713 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003714 * @deprecated As of API 21 this performs identically to
3715 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003716 */
3717 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003718 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003719 * This flag is used to open a document into a new task rooted at the activity launched
3720 * by this Intent. Through the use of this flag, or its equivalent attribute,
3721 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3722 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003723 *
Craig Mautner026596b2014-05-21 15:35:44 -07003724 * <p>The use of the activity attribute form of this,
3725 * {@link android.R.attr#documentLaunchMode}, is
3726 * preferred over the Intent flag described here. The attribute form allows the
3727 * Activity to specify multiple document behavior for all launchers of the Activity
3728 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003729 *
Craig Mautner026596b2014-05-21 15:35:44 -07003730 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3731 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3732 * equivalent of the Activity manifest specifying {@link
3733 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3734 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3735 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003736 *
Craig Mautner026596b2014-05-21 15:35:44 -07003737 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003738 *
Craig Mautner026596b2014-05-21 15:35:44 -07003739 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003740 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3741 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003742 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003743 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003744 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003745 * callback from occurring on the current frontmost activity before it is
3746 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003747 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003748 * <p>Typically, an activity can rely on that callback to indicate that an
3749 * explicit user action has caused their activity to be moved out of the
3750 * foreground. The callback marks an appropriate point in the activity's
3751 * lifecycle for it to dismiss any notifications that it intends to display
3752 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003753 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003754 * <p>If an activity is ever started via any non-user-driven events such as
3755 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3756 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003757 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003758 */
3759 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003760 /**
3761 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3762 * this flag will cause the launched activity to be brought to the front of its
3763 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003764 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003765 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3766 * If D calls startActivity() with an Intent that resolves to the component
3767 * of activity B, then B will be brought to the front of the history stack,
3768 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003769 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003770 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003771 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003772 */
3773 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003774 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003775 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3776 * this flag will prevent the system from applying an activity transition
3777 * animation to go to the next activity state. This doesn't mean an
3778 * animation will never run -- if another activity change happens that doesn't
3779 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003780 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003781 * when you are going to do a series of activity operations but the
3782 * animation seen by the user shouldn't be driven by the first activity
3783 * change but rather a later one.
3784 */
3785 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3786 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003787 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3788 * this flag will cause any existing task that would be associated with the
3789 * activity to be cleared before the activity is started. That is, the activity
3790 * becomes the new root of an otherwise empty task, and any old activities
3791 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3792 */
3793 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3794 /**
3795 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3796 * this flag will cause a newly launching task to be placed on top of the current
3797 * home activity task (if there is one). That is, pressing back from the task
3798 * will always return the user to home even if that was not the last activity they
3799 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3800 */
3801 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3802 /**
Craig Mautner2dac0562014-05-06 09:06:44 -07003803 * If set and the new activity is the root of a new task, then the task
3804 * will remain in the list of recently launched tasks only until all of
3805 * the activities in it are finished.
3806 *
3807 * <p>This is equivalent to the attribute
3808 * {@link android.R.styleable#AndroidManifestActivity_autoRemoveFromRecents}.
3809 */
3810 public static final int FLAG_ACTIVITY_AUTO_REMOVE_FROM_RECENTS = 0x00002000;
3811 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003812 * If set, when sending a broadcast only registered receivers will be
3813 * called -- no BroadcastReceiver components will be launched.
3814 */
3815 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003816 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003817 * If set, when sending a broadcast the new broadcast will replace
3818 * any existing pending broadcast that matches it. Matching is defined
3819 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3820 * true for the intents of the two broadcasts. When a match is found,
3821 * the new broadcast (and receivers associated with it) will replace the
3822 * existing one in the pending broadcast list, remaining at the same
3823 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003824 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003825 * <p>This flag is most typically used with sticky broadcasts, which
3826 * only care about delivering the most recent values of the broadcast
3827 * to their receivers.
3828 */
3829 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3830 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003831 * If set, when sending a broadcast the recipient is allowed to run at
3832 * foreground priority, with a shorter timeout interval. During normal
3833 * broadcasts the receivers are not automatically hoisted out of the
3834 * background priority class.
3835 */
3836 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3837 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003838 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3839 * They can still propagate results through to later receivers, but they can not prevent
3840 * later receivers from seeing the broadcast.
3841 */
3842 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3843 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003844 * If set, when sending a broadcast <i>before boot has completed</i> only
3845 * registered receivers will be called -- no BroadcastReceiver components
3846 * will be launched. Sticky intent state will be recorded properly even
3847 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3848 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003849 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003850 * <p>This flag is only for use by system sevices as a convenience to
3851 * avoid having to implement a more complex mechanism around detection
3852 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003853 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003854 * @hide
3855 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003856 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003857 /**
3858 * Set when this broadcast is for a boot upgrade, a special mode that
3859 * allows the broadcast to be sent before the system is ready and launches
3860 * the app process with no providers running in it.
3861 * @hide
3862 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003863 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003864
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003865 /**
3866 * @hide Flags that can't be changed with PendingIntent.
3867 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003868 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3869 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3870 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003871
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003872 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003873 // ---------------------------------------------------------------------
3874 // toUri() and parseUri() options.
3875
3876 /**
3877 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3878 * always has the "intent:" scheme. This syntax can be used when you want
3879 * to later disambiguate between URIs that are intended to describe an
3880 * Intent vs. all others that should be treated as raw URIs. When used
3881 * with {@link #parseUri}, any other scheme will result in a generic
3882 * VIEW action for that raw URI.
3883 */
3884 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003885
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003886 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003887
3888 private String mAction;
3889 private Uri mData;
3890 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003891 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003892 private ComponentName mComponent;
3893 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003894 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003895 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003896 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003897 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003898 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003899
3900 // ---------------------------------------------------------------------
3901
3902 /**
3903 * Create an empty intent.
3904 */
3905 public Intent() {
3906 }
3907
3908 /**
3909 * Copy constructor.
3910 */
3911 public Intent(Intent o) {
3912 this.mAction = o.mAction;
3913 this.mData = o.mData;
3914 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003915 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003916 this.mComponent = o.mComponent;
3917 this.mFlags = o.mFlags;
3918 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003919 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003920 }
3921 if (o.mExtras != null) {
3922 this.mExtras = new Bundle(o.mExtras);
3923 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003924 if (o.mSourceBounds != null) {
3925 this.mSourceBounds = new Rect(o.mSourceBounds);
3926 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003927 if (o.mSelector != null) {
3928 this.mSelector = new Intent(o.mSelector);
3929 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003930 if (o.mClipData != null) {
3931 this.mClipData = new ClipData(o.mClipData);
3932 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933 }
3934
3935 @Override
3936 public Object clone() {
3937 return new Intent(this);
3938 }
3939
3940 private Intent(Intent o, boolean all) {
3941 this.mAction = o.mAction;
3942 this.mData = o.mData;
3943 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003944 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003945 this.mComponent = o.mComponent;
3946 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003947 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948 }
3949 }
3950
3951 /**
3952 * Make a clone of only the parts of the Intent that are relevant for
3953 * filter matching: the action, data, type, component, and categories.
3954 */
3955 public Intent cloneFilter() {
3956 return new Intent(this, false);
3957 }
3958
3959 /**
3960 * Create an intent with a given action. All other fields (data, type,
3961 * class) are null. Note that the action <em>must</em> be in a
3962 * namespace because Intents are used globally in the system -- for
3963 * example the system VIEW action is android.intent.action.VIEW; an
3964 * application's custom action would be something like
3965 * com.google.app.myapp.CUSTOM_ACTION.
3966 *
3967 * @param action The Intent action, such as ACTION_VIEW.
3968 */
3969 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003970 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003971 }
3972
3973 /**
3974 * Create an intent with a given action and for a given data url. Note
3975 * that the action <em>must</em> be in a namespace because Intents are
3976 * used globally in the system -- for example the system VIEW action is
3977 * android.intent.action.VIEW; an application's custom action would be
3978 * something like com.google.app.myapp.CUSTOM_ACTION.
3979 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003980 * <p><em>Note: scheme and host name matching in the Android framework is
3981 * case-sensitive, unlike the formal RFC. As a result,
3982 * you should always ensure that you write your Uri with these elements
3983 * using lower case letters, and normalize any Uris you receive from
3984 * outside of Android to ensure the scheme and host is lower case.</em></p>
3985 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003986 * @param action The Intent action, such as ACTION_VIEW.
3987 * @param uri The Intent data URI.
3988 */
3989 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003990 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003991 mData = uri;
3992 }
3993
3994 /**
3995 * Create an intent for a specific component. All other fields (action, data,
3996 * type, class) are null, though they can be modified later with explicit
3997 * calls. This provides a convenient way to create an intent that is
3998 * intended to execute a hard-coded class name, rather than relying on the
3999 * system to find an appropriate class for you; see {@link #setComponent}
4000 * for more information on the repercussions of this.
4001 *
4002 * @param packageContext A Context of the application package implementing
4003 * this class.
4004 * @param cls The component class that is to be used for the intent.
4005 *
4006 * @see #setClass
4007 * @see #setComponent
4008 * @see #Intent(String, android.net.Uri , Context, Class)
4009 */
4010 public Intent(Context packageContext, Class<?> cls) {
4011 mComponent = new ComponentName(packageContext, cls);
4012 }
4013
4014 /**
4015 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004016 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004017 * construct the Intent and then calling {@link #setClass} to set its
4018 * class.
4019 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004020 * <p><em>Note: scheme and host name matching in the Android framework is
4021 * case-sensitive, unlike the formal RFC. As a result,
4022 * you should always ensure that you write your Uri with these elements
4023 * using lower case letters, and normalize any Uris you receive from
4024 * outside of Android to ensure the scheme and host is lower case.</em></p>
4025 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004026 * @param action The Intent action, such as ACTION_VIEW.
4027 * @param uri The Intent data URI.
4028 * @param packageContext A Context of the application package implementing
4029 * this class.
4030 * @param cls The component class that is to be used for the intent.
4031 *
4032 * @see #Intent(String, android.net.Uri)
4033 * @see #Intent(Context, Class)
4034 * @see #setClass
4035 * @see #setComponent
4036 */
4037 public Intent(String action, Uri uri,
4038 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004039 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004040 mData = uri;
4041 mComponent = new ComponentName(packageContext, cls);
4042 }
4043
4044 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004045 * Create an intent to launch the main (root) activity of a task. This
4046 * is the Intent that is started when the application's is launched from
4047 * Home. For anything else that wants to launch an application in the
4048 * same way, it is important that they use an Intent structured the same
4049 * way, and can use this function to ensure this is the case.
4050 *
4051 * <p>The returned Intent has the given Activity component as its explicit
4052 * component, {@link #ACTION_MAIN} as its action, and includes the
4053 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4054 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4055 * to do that through {@link #addFlags(int)} on the returned Intent.
4056 *
4057 * @param mainActivity The main activity component that this Intent will
4058 * launch.
4059 * @return Returns a newly created Intent that can be used to launch the
4060 * activity as a main application entry.
4061 *
4062 * @see #setClass
4063 * @see #setComponent
4064 */
4065 public static Intent makeMainActivity(ComponentName mainActivity) {
4066 Intent intent = new Intent(ACTION_MAIN);
4067 intent.setComponent(mainActivity);
4068 intent.addCategory(CATEGORY_LAUNCHER);
4069 return intent;
4070 }
4071
4072 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004073 * Make an Intent for the main activity of an application, without
4074 * specifying a specific activity to run but giving a selector to find
4075 * the activity. This results in a final Intent that is structured
4076 * the same as when the application is launched from
4077 * Home. For anything else that wants to launch an application in the
4078 * same way, it is important that they use an Intent structured the same
4079 * way, and can use this function to ensure this is the case.
4080 *
4081 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4082 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4083 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4084 * to do that through {@link #addFlags(int)} on the returned Intent.
4085 *
4086 * @param selectorAction The action name of the Intent's selector.
4087 * @param selectorCategory The name of a category to add to the Intent's
4088 * selector.
4089 * @return Returns a newly created Intent that can be used to launch the
4090 * activity as a main application entry.
4091 *
4092 * @see #setSelector(Intent)
4093 */
4094 public static Intent makeMainSelectorActivity(String selectorAction,
4095 String selectorCategory) {
4096 Intent intent = new Intent(ACTION_MAIN);
4097 intent.addCategory(CATEGORY_LAUNCHER);
4098 Intent selector = new Intent();
4099 selector.setAction(selectorAction);
4100 selector.addCategory(selectorCategory);
4101 intent.setSelector(selector);
4102 return intent;
4103 }
4104
4105 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004106 * Make an Intent that can be used to re-launch an application's task
4107 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4108 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4109 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4110 *
4111 * @param mainActivity The activity component that is the root of the
4112 * task; this is the activity that has been published in the application's
4113 * manifest as the main launcher icon.
4114 *
4115 * @return Returns a newly created Intent that can be used to relaunch the
4116 * activity's task in its root state.
4117 */
4118 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4119 Intent intent = makeMainActivity(mainActivity);
4120 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4121 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4122 return intent;
4123 }
4124
4125 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004126 * Call {@link #parseUri} with 0 flags.
4127 * @deprecated Use {@link #parseUri} instead.
4128 */
4129 @Deprecated
4130 public static Intent getIntent(String uri) throws URISyntaxException {
4131 return parseUri(uri, 0);
4132 }
Tom Taylord4a47292009-12-21 13:59:18 -08004133
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004134 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004135 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004136 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004137 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004138 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004139 *
4140 * <p>The URI given here must not be relative -- that is, it must include
4141 * the scheme and full path.
4142 *
4143 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004144 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004145 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004146 *
4147 * @return Intent The newly created Intent object.
4148 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004149 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4150 * it bad (as parsed by the Uri class) or the Intent data within the
4151 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004152 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004153 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004155 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004156 int i = 0;
4157 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004158 // Validate intent scheme for if requested.
4159 if ((flags&URI_INTENT_SCHEME) != 0) {
4160 if (!uri.startsWith("intent:")) {
4161 Intent intent = new Intent(ACTION_VIEW);
4162 try {
4163 intent.setData(Uri.parse(uri));
4164 } catch (IllegalArgumentException e) {
4165 throw new URISyntaxException(uri, e.getMessage());
4166 }
4167 return intent;
4168 }
4169 }
Tom Taylord4a47292009-12-21 13:59:18 -08004170
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004171 // simple case
4172 i = uri.lastIndexOf("#");
4173 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4174
4175 // old format Intent URI
4176 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004177
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004178 // new format
4179 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004180 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004181
4182 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004183 String data = i >= 0 ? uri.substring(0, i) : null;
4184 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004185 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004186
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004187 // loop over contents of Intent, all name=value;
4188 while (!uri.startsWith("end", i)) {
4189 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004190 if (eq < 0) eq = i-1;
4191 int semi = uri.indexOf(';', i);
4192 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004193
4194 // action
4195 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004196 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004197 }
4198
4199 // categories
4200 else if (uri.startsWith("category=", i)) {
4201 intent.addCategory(value);
4202 }
4203
4204 // type
4205 else if (uri.startsWith("type=", i)) {
4206 intent.mType = value;
4207 }
4208
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004209 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004210 else if (uri.startsWith("launchFlags=", i)) {
4211 intent.mFlags = Integer.decode(value).intValue();
4212 }
4213
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004214 // package
4215 else if (uri.startsWith("package=", i)) {
4216 intent.mPackage = value;
4217 }
4218
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004219 // component
4220 else if (uri.startsWith("component=", i)) {
4221 intent.mComponent = ComponentName.unflattenFromString(value);
4222 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004223
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004224 // scheme
4225 else if (uri.startsWith("scheme=", i)) {
4226 scheme = value;
4227 }
4228
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004229 // source bounds
4230 else if (uri.startsWith("sourceBounds=", i)) {
4231 intent.mSourceBounds = Rect.unflattenFromString(value);
4232 }
4233
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004234 // selector
4235 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4236 intent = new Intent();
4237 }
4238
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004239 // extra
4240 else {
4241 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004242 // create Bundle if it doesn't already exist
4243 if (intent.mExtras == null) intent.mExtras = new Bundle();
4244 Bundle b = intent.mExtras;
4245 // add EXTRA
4246 if (uri.startsWith("S.", i)) b.putString(key, value);
4247 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4248 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4249 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4250 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4251 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4252 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4253 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4254 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4255 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4256 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004257
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004258 // move to the next item
4259 i = semi + 1;
4260 }
4261
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004262 if (intent != baseIntent) {
4263 // The Intent had a selector; fix it up.
4264 baseIntent.setSelector(intent);
4265 intent = baseIntent;
4266 }
4267
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004268 if (data != null) {
4269 if (data.startsWith("intent:")) {
4270 data = data.substring(7);
4271 if (scheme != null) {
4272 data = scheme + ':' + data;
4273 }
4274 }
Tom Taylord4a47292009-12-21 13:59:18 -08004275
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004276 if (data.length() > 0) {
4277 try {
4278 intent.mData = Uri.parse(data);
4279 } catch (IllegalArgumentException e) {
4280 throw new URISyntaxException(uri, e.getMessage());
4281 }
4282 }
4283 }
Tom Taylord4a47292009-12-21 13:59:18 -08004284
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004285 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004286
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004287 } catch (IndexOutOfBoundsException e) {
4288 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4289 }
4290 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004291
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004292 public static Intent getIntentOld(String uri) throws URISyntaxException {
4293 Intent intent;
4294
4295 int i = uri.lastIndexOf('#');
4296 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004297 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004298 final int intentFragmentStart = i;
4299 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004300
4301 i++;
4302
4303 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004304 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004305 i += 7;
4306 int j = uri.indexOf(')', i);
4307 action = uri.substring(i, j);
4308 i = j + 1;
4309 }
4310
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004311 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004312
4313 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004314 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004315 i += 11;
4316 int j = uri.indexOf(')', i);
4317 while (i < j) {
4318 int sep = uri.indexOf('!', i);
4319 if (sep < 0) sep = j;
4320 if (i < sep) {
4321 intent.addCategory(uri.substring(i, sep));
4322 }
4323 i = sep + 1;
4324 }
4325 i = j + 1;
4326 }
4327
4328 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004329 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004330 i += 5;
4331 int j = uri.indexOf(')', i);
4332 intent.mType = uri.substring(i, j);
4333 i = j + 1;
4334 }
4335
4336 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004337 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004338 i += 12;
4339 int j = uri.indexOf(')', i);
4340 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4341 i = j + 1;
4342 }
4343
4344 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004345 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004346 i += 10;
4347 int j = uri.indexOf(')', i);
4348 int sep = uri.indexOf('!', i);
4349 if (sep >= 0 && sep < j) {
4350 String pkg = uri.substring(i, sep);
4351 String cls = uri.substring(sep + 1, j);
4352 intent.mComponent = new ComponentName(pkg, cls);
4353 }
4354 i = j + 1;
4355 }
4356
4357 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004358 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004359 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004360
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004361 final int closeParen = uri.indexOf(')', i);
4362 if (closeParen == -1) throw new URISyntaxException(uri,
4363 "EXTRA missing trailing ')'", i);
4364
4365 while (i < closeParen) {
4366 // fetch the key value
4367 int j = uri.indexOf('=', i);
4368 if (j <= i + 1 || i >= closeParen) {
4369 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4370 }
4371 char type = uri.charAt(i);
4372 i++;
4373 String key = uri.substring(i, j);
4374 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004375
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004376 // get type-value
4377 j = uri.indexOf('!', i);
4378 if (j == -1 || j >= closeParen) j = closeParen;
4379 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4380 String value = uri.substring(i, j);
4381 i = j;
4382
4383 // create Bundle if it doesn't already exist
4384 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004385
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004386 // add item to bundle
4387 try {
4388 switch (type) {
4389 case 'S':
4390 intent.mExtras.putString(key, Uri.decode(value));
4391 break;
4392 case 'B':
4393 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4394 break;
4395 case 'b':
4396 intent.mExtras.putByte(key, Byte.parseByte(value));
4397 break;
4398 case 'c':
4399 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4400 break;
4401 case 'd':
4402 intent.mExtras.putDouble(key, Double.parseDouble(value));
4403 break;
4404 case 'f':
4405 intent.mExtras.putFloat(key, Float.parseFloat(value));
4406 break;
4407 case 'i':
4408 intent.mExtras.putInt(key, Integer.parseInt(value));
4409 break;
4410 case 'l':
4411 intent.mExtras.putLong(key, Long.parseLong(value));
4412 break;
4413 case 's':
4414 intent.mExtras.putShort(key, Short.parseShort(value));
4415 break;
4416 default:
4417 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4418 }
4419 } catch (NumberFormatException e) {
4420 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4421 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004423 char ch = uri.charAt(i);
4424 if (ch == ')') break;
4425 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4426 i++;
4427 }
4428 }
4429
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004430 if (isIntentFragment) {
4431 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4432 } else {
4433 intent.mData = Uri.parse(uri);
4434 }
Tom Taylord4a47292009-12-21 13:59:18 -08004435
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004436 if (intent.mAction == null) {
4437 // By default, if no action is specified, then use VIEW.
4438 intent.mAction = ACTION_VIEW;
4439 }
4440
4441 } else {
4442 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4443 }
4444
4445 return intent;
4446 }
4447
4448 /**
4449 * Retrieve the general action to be performed, such as
4450 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4451 * the information in the intent should be interpreted -- most importantly,
4452 * what to do with the data returned by {@link #getData}.
4453 *
4454 * @return The action of this intent or null if none is specified.
4455 *
4456 * @see #setAction
4457 */
4458 public String getAction() {
4459 return mAction;
4460 }
4461
4462 /**
4463 * Retrieve data this intent is operating on. This URI specifies the name
4464 * of the data; often it uses the content: scheme, specifying data in a
4465 * content provider. Other schemes may be handled by specific activities,
4466 * such as http: by the web browser.
4467 *
4468 * @return The URI of the data this intent is targeting or null.
4469 *
4470 * @see #getScheme
4471 * @see #setData
4472 */
4473 public Uri getData() {
4474 return mData;
4475 }
4476
4477 /**
4478 * The same as {@link #getData()}, but returns the URI as an encoded
4479 * String.
4480 */
4481 public String getDataString() {
4482 return mData != null ? mData.toString() : null;
4483 }
4484
4485 /**
4486 * Return the scheme portion of the intent's data. If the data is null or
4487 * does not include a scheme, null is returned. Otherwise, the scheme
4488 * prefix without the final ':' is returned, i.e. "http".
4489 *
4490 * <p>This is the same as calling getData().getScheme() (and checking for
4491 * null data).
4492 *
4493 * @return The scheme of this intent.
4494 *
4495 * @see #getData
4496 */
4497 public String getScheme() {
4498 return mData != null ? mData.getScheme() : null;
4499 }
4500
4501 /**
4502 * Retrieve any explicit MIME type included in the intent. This is usually
4503 * null, as the type is determined by the intent data.
4504 *
4505 * @return If a type was manually set, it is returned; else null is
4506 * returned.
4507 *
4508 * @see #resolveType(ContentResolver)
4509 * @see #setType
4510 */
4511 public String getType() {
4512 return mType;
4513 }
4514
4515 /**
4516 * Return the MIME data type of this intent. If the type field is
4517 * explicitly set, that is simply returned. Otherwise, if the data is set,
4518 * the type of that data is returned. If neither fields are set, a null is
4519 * returned.
4520 *
4521 * @return The MIME type of this intent.
4522 *
4523 * @see #getType
4524 * @see #resolveType(ContentResolver)
4525 */
4526 public String resolveType(Context context) {
4527 return resolveType(context.getContentResolver());
4528 }
4529
4530 /**
4531 * Return the MIME data type of this intent. If the type field is
4532 * explicitly set, that is simply returned. Otherwise, if the data is set,
4533 * the type of that data is returned. If neither fields are set, a null is
4534 * returned.
4535 *
4536 * @param resolver A ContentResolver that can be used to determine the MIME
4537 * type of the intent's data.
4538 *
4539 * @return The MIME type of this intent.
4540 *
4541 * @see #getType
4542 * @see #resolveType(Context)
4543 */
4544 public String resolveType(ContentResolver resolver) {
4545 if (mType != null) {
4546 return mType;
4547 }
4548 if (mData != null) {
4549 if ("content".equals(mData.getScheme())) {
4550 return resolver.getType(mData);
4551 }
4552 }
4553 return null;
4554 }
4555
4556 /**
4557 * Return the MIME data type of this intent, only if it will be needed for
4558 * intent resolution. This is not generally useful for application code;
4559 * it is used by the frameworks for communicating with back-end system
4560 * services.
4561 *
4562 * @param resolver A ContentResolver that can be used to determine the MIME
4563 * type of the intent's data.
4564 *
4565 * @return The MIME type of this intent, or null if it is unknown or not
4566 * needed.
4567 */
4568 public String resolveTypeIfNeeded(ContentResolver resolver) {
4569 if (mComponent != null) {
4570 return mType;
4571 }
4572 return resolveType(resolver);
4573 }
4574
4575 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004576 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004577 *
4578 * @param category The category to check.
4579 *
4580 * @return boolean True if the intent contains the category, else false.
4581 *
4582 * @see #getCategories
4583 * @see #addCategory
4584 */
4585 public boolean hasCategory(String category) {
4586 return mCategories != null && mCategories.contains(category);
4587 }
4588
4589 /**
4590 * Return the set of all categories in the intent. If there are no categories,
4591 * returns NULL.
4592 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004593 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004594 *
4595 * @see #hasCategory
4596 * @see #addCategory
4597 */
4598 public Set<String> getCategories() {
4599 return mCategories;
4600 }
4601
4602 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004603 * Return the specific selector associated with this Intent. If there is
4604 * none, returns null. See {@link #setSelector} for more information.
4605 *
4606 * @see #setSelector
4607 */
4608 public Intent getSelector() {
4609 return mSelector;
4610 }
4611
4612 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004613 * Return the {@link ClipData} associated with this Intent. If there is
4614 * none, returns null. See {@link #setClipData} for more information.
4615 *
John Spurlock125d1332013-11-25 11:58:37 -05004616 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004617 */
4618 public ClipData getClipData() {
4619 return mClipData;
4620 }
4621
4622 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004623 * Sets the ClassLoader that will be used when unmarshalling
4624 * any Parcelable values from the extras of this Intent.
4625 *
4626 * @param loader a ClassLoader, or null to use the default loader
4627 * at the time of unmarshalling.
4628 */
4629 public void setExtrasClassLoader(ClassLoader loader) {
4630 if (mExtras != null) {
4631 mExtras.setClassLoader(loader);
4632 }
4633 }
4634
4635 /**
4636 * Returns true if an extra value is associated with the given name.
4637 * @param name the extra's name
4638 * @return true if the given extra is present.
4639 */
4640 public boolean hasExtra(String name) {
4641 return mExtras != null && mExtras.containsKey(name);
4642 }
4643
4644 /**
4645 * Returns true if the Intent's extras contain a parcelled file descriptor.
4646 * @return true if the Intent contains a parcelled file descriptor.
4647 */
4648 public boolean hasFileDescriptors() {
4649 return mExtras != null && mExtras.hasFileDescriptors();
4650 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004651
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004652 /** @hide */
4653 public void setAllowFds(boolean allowFds) {
4654 if (mExtras != null) {
4655 mExtras.setAllowFds(allowFds);
4656 }
4657 }
4658
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004659 /**
4660 * Retrieve extended data from the intent.
4661 *
4662 * @param name The name of the desired item.
4663 *
4664 * @return the value of an item that previously added with putExtra()
4665 * or null if none was found.
4666 *
4667 * @deprecated
4668 * @hide
4669 */
4670 @Deprecated
4671 public Object getExtra(String name) {
4672 return getExtra(name, null);
4673 }
4674
4675 /**
4676 * Retrieve extended data from the intent.
4677 *
4678 * @param name The name of the desired item.
4679 * @param defaultValue the value to be returned if no value of the desired
4680 * type is stored with the given name.
4681 *
4682 * @return the value of an item that previously added with putExtra()
4683 * or the default value if none was found.
4684 *
4685 * @see #putExtra(String, boolean)
4686 */
4687 public boolean getBooleanExtra(String name, boolean defaultValue) {
4688 return mExtras == null ? defaultValue :
4689 mExtras.getBoolean(name, defaultValue);
4690 }
4691
4692 /**
4693 * Retrieve extended data from the intent.
4694 *
4695 * @param name The name of the desired item.
4696 * @param defaultValue the value to be returned if no value of the desired
4697 * type is stored with the given name.
4698 *
4699 * @return the value of an item that previously added with putExtra()
4700 * or the default value if none was found.
4701 *
4702 * @see #putExtra(String, byte)
4703 */
4704 public byte getByteExtra(String name, byte defaultValue) {
4705 return mExtras == null ? defaultValue :
4706 mExtras.getByte(name, defaultValue);
4707 }
4708
4709 /**
4710 * Retrieve extended data from the intent.
4711 *
4712 * @param name The name of the desired item.
4713 * @param defaultValue the value to be returned if no value of the desired
4714 * type is stored with the given name.
4715 *
4716 * @return the value of an item that previously added with putExtra()
4717 * or the default value if none was found.
4718 *
4719 * @see #putExtra(String, short)
4720 */
4721 public short getShortExtra(String name, short defaultValue) {
4722 return mExtras == null ? defaultValue :
4723 mExtras.getShort(name, defaultValue);
4724 }
4725
4726 /**
4727 * Retrieve extended data from the intent.
4728 *
4729 * @param name The name of the desired item.
4730 * @param defaultValue the value to be returned if no value of the desired
4731 * type is stored with the given name.
4732 *
4733 * @return the value of an item that previously added with putExtra()
4734 * or the default value if none was found.
4735 *
4736 * @see #putExtra(String, char)
4737 */
4738 public char getCharExtra(String name, char defaultValue) {
4739 return mExtras == null ? defaultValue :
4740 mExtras.getChar(name, defaultValue);
4741 }
4742
4743 /**
4744 * Retrieve extended data from the intent.
4745 *
4746 * @param name The name of the desired item.
4747 * @param defaultValue the value to be returned if no value of the desired
4748 * type is stored with the given name.
4749 *
4750 * @return the value of an item that previously added with putExtra()
4751 * or the default value if none was found.
4752 *
4753 * @see #putExtra(String, int)
4754 */
4755 public int getIntExtra(String name, int defaultValue) {
4756 return mExtras == null ? defaultValue :
4757 mExtras.getInt(name, defaultValue);
4758 }
4759
4760 /**
4761 * Retrieve extended data from the intent.
4762 *
4763 * @param name The name of the desired item.
4764 * @param defaultValue the value to be returned if no value of the desired
4765 * type is stored with the given name.
4766 *
4767 * @return the value of an item that previously added with putExtra()
4768 * or the default value if none was found.
4769 *
4770 * @see #putExtra(String, long)
4771 */
4772 public long getLongExtra(String name, long defaultValue) {
4773 return mExtras == null ? defaultValue :
4774 mExtras.getLong(name, defaultValue);
4775 }
4776
4777 /**
4778 * Retrieve extended data from the intent.
4779 *
4780 * @param name The name of the desired item.
4781 * @param defaultValue the value to be returned if no value of the desired
4782 * type is stored with the given name.
4783 *
4784 * @return the value of an item that previously added with putExtra(),
4785 * or the default value if no such item is present
4786 *
4787 * @see #putExtra(String, float)
4788 */
4789 public float getFloatExtra(String name, float defaultValue) {
4790 return mExtras == null ? defaultValue :
4791 mExtras.getFloat(name, defaultValue);
4792 }
4793
4794 /**
4795 * Retrieve extended data from the intent.
4796 *
4797 * @param name The name of the desired item.
4798 * @param defaultValue the value to be returned if no value of the desired
4799 * type is stored with the given name.
4800 *
4801 * @return the value of an item that previously added with putExtra()
4802 * or the default value if none was found.
4803 *
4804 * @see #putExtra(String, double)
4805 */
4806 public double getDoubleExtra(String name, double defaultValue) {
4807 return mExtras == null ? defaultValue :
4808 mExtras.getDouble(name, defaultValue);
4809 }
4810
4811 /**
4812 * Retrieve extended data from the intent.
4813 *
4814 * @param name The name of the desired item.
4815 *
4816 * @return the value of an item that previously added with putExtra()
4817 * or null if no String value was found.
4818 *
4819 * @see #putExtra(String, String)
4820 */
4821 public String getStringExtra(String name) {
4822 return mExtras == null ? null : mExtras.getString(name);
4823 }
4824
4825 /**
4826 * Retrieve extended data from the intent.
4827 *
4828 * @param name The name of the desired item.
4829 *
4830 * @return the value of an item that previously added with putExtra()
4831 * or null if no CharSequence value was found.
4832 *
4833 * @see #putExtra(String, CharSequence)
4834 */
4835 public CharSequence getCharSequenceExtra(String name) {
4836 return mExtras == null ? null : mExtras.getCharSequence(name);
4837 }
4838
4839 /**
4840 * Retrieve extended data from the intent.
4841 *
4842 * @param name The name of the desired item.
4843 *
4844 * @return the value of an item that previously added with putExtra()
4845 * or null if no Parcelable value was found.
4846 *
4847 * @see #putExtra(String, Parcelable)
4848 */
4849 public <T extends Parcelable> T getParcelableExtra(String name) {
4850 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4851 }
4852
4853 /**
4854 * Retrieve extended data from the intent.
4855 *
4856 * @param name The name of the desired item.
4857 *
4858 * @return the value of an item that previously added with putExtra()
4859 * or null if no Parcelable[] value was found.
4860 *
4861 * @see #putExtra(String, Parcelable[])
4862 */
4863 public Parcelable[] getParcelableArrayExtra(String name) {
4864 return mExtras == null ? null : mExtras.getParcelableArray(name);
4865 }
4866
4867 /**
4868 * Retrieve extended data from the intent.
4869 *
4870 * @param name The name of the desired item.
4871 *
4872 * @return the value of an item that previously added with putExtra()
4873 * or null if no ArrayList<Parcelable> value was found.
4874 *
4875 * @see #putParcelableArrayListExtra(String, ArrayList)
4876 */
4877 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4878 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4879 }
4880
4881 /**
4882 * Retrieve extended data from the intent.
4883 *
4884 * @param name The name of the desired item.
4885 *
4886 * @return the value of an item that previously added with putExtra()
4887 * or null if no Serializable value was found.
4888 *
4889 * @see #putExtra(String, Serializable)
4890 */
4891 public Serializable getSerializableExtra(String name) {
4892 return mExtras == null ? null : mExtras.getSerializable(name);
4893 }
4894
4895 /**
4896 * Retrieve extended data from the intent.
4897 *
4898 * @param name The name of the desired item.
4899 *
4900 * @return the value of an item that previously added with putExtra()
4901 * or null if no ArrayList<Integer> value was found.
4902 *
4903 * @see #putIntegerArrayListExtra(String, ArrayList)
4904 */
4905 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4906 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4907 }
4908
4909 /**
4910 * Retrieve extended data from the intent.
4911 *
4912 * @param name The name of the desired item.
4913 *
4914 * @return the value of an item that previously added with putExtra()
4915 * or null if no ArrayList<String> value was found.
4916 *
4917 * @see #putStringArrayListExtra(String, ArrayList)
4918 */
4919 public ArrayList<String> getStringArrayListExtra(String name) {
4920 return mExtras == null ? null : mExtras.getStringArrayList(name);
4921 }
4922
4923 /**
4924 * Retrieve extended data from the intent.
4925 *
4926 * @param name The name of the desired item.
4927 *
4928 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004929 * or null if no ArrayList<CharSequence> value was found.
4930 *
4931 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4932 */
4933 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4934 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4935 }
4936
4937 /**
4938 * Retrieve extended data from the intent.
4939 *
4940 * @param name The name of the desired item.
4941 *
4942 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004943 * or null if no boolean array value was found.
4944 *
4945 * @see #putExtra(String, boolean[])
4946 */
4947 public boolean[] getBooleanArrayExtra(String name) {
4948 return mExtras == null ? null : mExtras.getBooleanArray(name);
4949 }
4950
4951 /**
4952 * Retrieve extended data from the intent.
4953 *
4954 * @param name The name of the desired item.
4955 *
4956 * @return the value of an item that previously added with putExtra()
4957 * or null if no byte array value was found.
4958 *
4959 * @see #putExtra(String, byte[])
4960 */
4961 public byte[] getByteArrayExtra(String name) {
4962 return mExtras == null ? null : mExtras.getByteArray(name);
4963 }
4964
4965 /**
4966 * Retrieve extended data from the intent.
4967 *
4968 * @param name The name of the desired item.
4969 *
4970 * @return the value of an item that previously added with putExtra()
4971 * or null if no short array value was found.
4972 *
4973 * @see #putExtra(String, short[])
4974 */
4975 public short[] getShortArrayExtra(String name) {
4976 return mExtras == null ? null : mExtras.getShortArray(name);
4977 }
4978
4979 /**
4980 * Retrieve extended data from the intent.
4981 *
4982 * @param name The name of the desired item.
4983 *
4984 * @return the value of an item that previously added with putExtra()
4985 * or null if no char array value was found.
4986 *
4987 * @see #putExtra(String, char[])
4988 */
4989 public char[] getCharArrayExtra(String name) {
4990 return mExtras == null ? null : mExtras.getCharArray(name);
4991 }
4992
4993 /**
4994 * Retrieve extended data from the intent.
4995 *
4996 * @param name The name of the desired item.
4997 *
4998 * @return the value of an item that previously added with putExtra()
4999 * or null if no int array value was found.
5000 *
5001 * @see #putExtra(String, int[])
5002 */
5003 public int[] getIntArrayExtra(String name) {
5004 return mExtras == null ? null : mExtras.getIntArray(name);
5005 }
5006
5007 /**
5008 * Retrieve extended data from the intent.
5009 *
5010 * @param name The name of the desired item.
5011 *
5012 * @return the value of an item that previously added with putExtra()
5013 * or null if no long array value was found.
5014 *
5015 * @see #putExtra(String, long[])
5016 */
5017 public long[] getLongArrayExtra(String name) {
5018 return mExtras == null ? null : mExtras.getLongArray(name);
5019 }
5020
5021 /**
5022 * Retrieve extended data from the intent.
5023 *
5024 * @param name The name of the desired item.
5025 *
5026 * @return the value of an item that previously added with putExtra()
5027 * or null if no float array value was found.
5028 *
5029 * @see #putExtra(String, float[])
5030 */
5031 public float[] getFloatArrayExtra(String name) {
5032 return mExtras == null ? null : mExtras.getFloatArray(name);
5033 }
5034
5035 /**
5036 * Retrieve extended data from the intent.
5037 *
5038 * @param name The name of the desired item.
5039 *
5040 * @return the value of an item that previously added with putExtra()
5041 * or null if no double array value was found.
5042 *
5043 * @see #putExtra(String, double[])
5044 */
5045 public double[] getDoubleArrayExtra(String name) {
5046 return mExtras == null ? null : mExtras.getDoubleArray(name);
5047 }
5048
5049 /**
5050 * Retrieve extended data from the intent.
5051 *
5052 * @param name The name of the desired item.
5053 *
5054 * @return the value of an item that previously added with putExtra()
5055 * or null if no String array value was found.
5056 *
5057 * @see #putExtra(String, String[])
5058 */
5059 public String[] getStringArrayExtra(String name) {
5060 return mExtras == null ? null : mExtras.getStringArray(name);
5061 }
5062
5063 /**
5064 * Retrieve extended data from the intent.
5065 *
5066 * @param name The name of the desired item.
5067 *
5068 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005069 * or null if no CharSequence array value was found.
5070 *
5071 * @see #putExtra(String, CharSequence[])
5072 */
5073 public CharSequence[] getCharSequenceArrayExtra(String name) {
5074 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5075 }
5076
5077 /**
5078 * Retrieve extended data from the intent.
5079 *
5080 * @param name The name of the desired item.
5081 *
5082 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005083 * or null if no Bundle value was found.
5084 *
5085 * @see #putExtra(String, Bundle)
5086 */
5087 public Bundle getBundleExtra(String name) {
5088 return mExtras == null ? null : mExtras.getBundle(name);
5089 }
5090
5091 /**
5092 * Retrieve extended data from the intent.
5093 *
5094 * @param name The name of the desired item.
5095 *
5096 * @return the value of an item that previously added with putExtra()
5097 * or null if no IBinder value was found.
5098 *
5099 * @see #putExtra(String, IBinder)
5100 *
5101 * @deprecated
5102 * @hide
5103 */
5104 @Deprecated
5105 public IBinder getIBinderExtra(String name) {
5106 return mExtras == null ? null : mExtras.getIBinder(name);
5107 }
5108
5109 /**
5110 * Retrieve extended data from the intent.
5111 *
5112 * @param name The name of the desired item.
5113 * @param defaultValue The default value to return in case no item is
5114 * associated with the key 'name'
5115 *
5116 * @return the value of an item that previously added with putExtra()
5117 * or defaultValue if none was found.
5118 *
5119 * @see #putExtra
5120 *
5121 * @deprecated
5122 * @hide
5123 */
5124 @Deprecated
5125 public Object getExtra(String name, Object defaultValue) {
5126 Object result = defaultValue;
5127 if (mExtras != null) {
5128 Object result2 = mExtras.get(name);
5129 if (result2 != null) {
5130 result = result2;
5131 }
5132 }
5133
5134 return result;
5135 }
5136
5137 /**
5138 * Retrieves a map of extended data from the intent.
5139 *
5140 * @return the map of all extras previously added with putExtra(),
5141 * or null if none have been added.
5142 */
5143 public Bundle getExtras() {
5144 return (mExtras != null)
5145 ? new Bundle(mExtras)
5146 : null;
5147 }
5148
5149 /**
5150 * Retrieve any special flags associated with this intent. You will
5151 * normally just set them with {@link #setFlags} and let the system
5152 * take the appropriate action with them.
5153 *
5154 * @return int The currently set flags.
5155 *
5156 * @see #setFlags
5157 */
5158 public int getFlags() {
5159 return mFlags;
5160 }
5161
Dianne Hackborne7f97212011-02-24 14:40:20 -08005162 /** @hide */
5163 public boolean isExcludingStopped() {
5164 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5165 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5166 }
5167
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005168 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005169 * Retrieve the application package name this Intent is limited to. When
5170 * resolving an Intent, if non-null this limits the resolution to only
5171 * components in the given application package.
5172 *
5173 * @return The name of the application package for the Intent.
5174 *
5175 * @see #resolveActivity
5176 * @see #setPackage
5177 */
5178 public String getPackage() {
5179 return mPackage;
5180 }
5181
5182 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005183 * Retrieve the concrete component associated with the intent. When receiving
5184 * an intent, this is the component that was found to best handle it (that is,
5185 * yourself) and will always be non-null; in all other cases it will be
5186 * null unless explicitly set.
5187 *
5188 * @return The name of the application component to handle the intent.
5189 *
5190 * @see #resolveActivity
5191 * @see #setComponent
5192 */
5193 public ComponentName getComponent() {
5194 return mComponent;
5195 }
5196
5197 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005198 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5199 * used as a hint to the receiver for animations and the like. Null means that there
5200 * is no source bounds.
5201 */
5202 public Rect getSourceBounds() {
5203 return mSourceBounds;
5204 }
5205
5206 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005207 * Return the Activity component that should be used to handle this intent.
5208 * The appropriate component is determined based on the information in the
5209 * intent, evaluated as follows:
5210 *
5211 * <p>If {@link #getComponent} returns an explicit class, that is returned
5212 * without any further consideration.
5213 *
5214 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5215 * category to be considered.
5216 *
5217 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5218 * action.
5219 *
5220 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5221 * this type.
5222 *
5223 * <p>If {@link #addCategory} has added any categories, the activity must
5224 * handle ALL of the categories specified.
5225 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005226 * <p>If {@link #getPackage} is non-NULL, only activity components in
5227 * that application package will be considered.
5228 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005229 * <p>If there are no activities that satisfy all of these conditions, a
5230 * null string is returned.
5231 *
5232 * <p>If multiple activities are found to satisfy the intent, the one with
5233 * the highest priority will be used. If there are multiple activities
5234 * with the same priority, the system will either pick the best activity
5235 * based on user preference, or resolve to a system class that will allow
5236 * the user to pick an activity and forward from there.
5237 *
5238 * <p>This method is implemented simply by calling
5239 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5240 * true.</p>
5241 * <p> This API is called for you as part of starting an activity from an
5242 * intent. You do not normally need to call it yourself.</p>
5243 *
5244 * @param pm The package manager with which to resolve the Intent.
5245 *
5246 * @return Name of the component implementing an activity that can
5247 * display the intent.
5248 *
5249 * @see #setComponent
5250 * @see #getComponent
5251 * @see #resolveActivityInfo
5252 */
5253 public ComponentName resolveActivity(PackageManager pm) {
5254 if (mComponent != null) {
5255 return mComponent;
5256 }
5257
5258 ResolveInfo info = pm.resolveActivity(
5259 this, PackageManager.MATCH_DEFAULT_ONLY);
5260 if (info != null) {
5261 return new ComponentName(
5262 info.activityInfo.applicationInfo.packageName,
5263 info.activityInfo.name);
5264 }
5265
5266 return null;
5267 }
5268
5269 /**
5270 * Resolve the Intent into an {@link ActivityInfo}
5271 * describing the activity that should execute the intent. Resolution
5272 * follows the same rules as described for {@link #resolveActivity}, but
5273 * you get back the completely information about the resolved activity
5274 * instead of just its class name.
5275 *
5276 * @param pm The package manager with which to resolve the Intent.
5277 * @param flags Addition information to retrieve as per
5278 * {@link PackageManager#getActivityInfo(ComponentName, int)
5279 * PackageManager.getActivityInfo()}.
5280 *
5281 * @return PackageManager.ActivityInfo
5282 *
5283 * @see #resolveActivity
5284 */
5285 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5286 ActivityInfo ai = null;
5287 if (mComponent != null) {
5288 try {
5289 ai = pm.getActivityInfo(mComponent, flags);
5290 } catch (PackageManager.NameNotFoundException e) {
5291 // ignore
5292 }
5293 } else {
5294 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005295 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005296 if (info != null) {
5297 ai = info.activityInfo;
5298 }
5299 }
5300
5301 return ai;
5302 }
5303
5304 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005305 * Special function for use by the system to resolve service
5306 * intents to system apps. Throws an exception if there are
5307 * multiple potential matches to the Intent. Returns null if
5308 * there are no matches.
5309 * @hide
5310 */
5311 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5312 if (mComponent != null) {
5313 return mComponent;
5314 }
5315
5316 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5317 if (results == null) {
5318 return null;
5319 }
5320 ComponentName comp = null;
5321 for (int i=0; i<results.size(); i++) {
5322 ResolveInfo ri = results.get(i);
5323 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5324 continue;
5325 }
5326 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5327 ri.serviceInfo.name);
5328 if (comp != null) {
5329 throw new IllegalStateException("Multiple system services handle " + this
5330 + ": " + comp + ", " + foundComp);
5331 }
5332 comp = foundComp;
5333 }
5334 return comp;
5335 }
5336
5337 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005338 * Set the general action to be performed.
5339 *
5340 * @param action An action name, such as ACTION_VIEW. Application-specific
5341 * actions should be prefixed with the vendor's package name.
5342 *
5343 * @return Returns the same Intent object, for chaining multiple calls
5344 * into a single statement.
5345 *
5346 * @see #getAction
5347 */
5348 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005349 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005350 return this;
5351 }
5352
5353 /**
5354 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005355 * clears any type that was previously set by {@link #setType} or
5356 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005357 *
Nick Pellyccae4122012-01-09 14:12:58 -08005358 * <p><em>Note: scheme matching in the Android framework is
5359 * case-sensitive, unlike the formal RFC. As a result,
5360 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005361 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005362 * {@link #setDataAndNormalize}
5363 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005364 *
Nick Pellyccae4122012-01-09 14:12:58 -08005365 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005366 *
5367 * @return Returns the same Intent object, for chaining multiple calls
5368 * into a single statement.
5369 *
5370 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005371 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005372 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005373 */
5374 public Intent setData(Uri data) {
5375 mData = data;
5376 mType = null;
5377 return this;
5378 }
5379
5380 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005381 * Normalize and set the data this intent is operating on.
5382 *
5383 * <p>This method automatically clears any type that was
5384 * previously set (for example, by {@link #setType}).
5385 *
5386 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005387 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005388 * so really this is just a convenience method for
5389 * <pre>
5390 * setData(data.normalize())
5391 * </pre>
5392 *
5393 * @param data The Uri of the data this intent is now targeting.
5394 *
5395 * @return Returns the same Intent object, for chaining multiple calls
5396 * into a single statement.
5397 *
5398 * @see #getData
5399 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005400 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005401 */
5402 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005403 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005404 }
5405
5406 /**
5407 * Set an explicit MIME data type.
5408 *
5409 * <p>This is used to create intents that only specify a type and not data,
5410 * for example to indicate the type of data to return.
5411 *
5412 * <p>This method automatically clears any data that was
5413 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005414 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005415 * <p><em>Note: MIME type matching in the Android framework is
5416 * case-sensitive, unlike formal RFC MIME types. As a result,
5417 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005418 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5419 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005420 *
5421 * @param type The MIME type of the data being handled by this intent.
5422 *
5423 * @return Returns the same Intent object, for chaining multiple calls
5424 * into a single statement.
5425 *
5426 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005427 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005428 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005429 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005430 */
5431 public Intent setType(String type) {
5432 mData = null;
5433 mType = type;
5434 return this;
5435 }
5436
5437 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005438 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005439 *
Nick Pellyccae4122012-01-09 14:12:58 -08005440 * <p>This is used to create intents that only specify a type and not data,
5441 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005442 *
Nick Pellyccae4122012-01-09 14:12:58 -08005443 * <p>This method automatically clears any data that was
5444 * previously set (for example by {@link #setData}).
5445 *
5446 * <p>The MIME type is normalized using
5447 * {@link #normalizeMimeType} before it is set,
5448 * so really this is just a convenience method for
5449 * <pre>
5450 * setType(Intent.normalizeMimeType(type))
5451 * </pre>
5452 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005453 * @param type The MIME type of the data being handled by this intent.
5454 *
5455 * @return Returns the same Intent object, for chaining multiple calls
5456 * into a single statement.
5457 *
Nick Pellyccae4122012-01-09 14:12:58 -08005458 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005459 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005460 * @see #normalizeMimeType
5461 */
5462 public Intent setTypeAndNormalize(String type) {
5463 return setType(normalizeMimeType(type));
5464 }
5465
5466 /**
5467 * (Usually optional) Set the data for the intent along with an explicit
5468 * MIME data type. This method should very rarely be used -- it allows you
5469 * to override the MIME type that would ordinarily be inferred from the
5470 * data with your own type given here.
5471 *
5472 * <p><em>Note: MIME type and Uri scheme matching in the
5473 * Android framework is case-sensitive, unlike the formal RFC definitions.
5474 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005475 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005476 * {@link #setDataAndTypeAndNormalize}
5477 * to ensure that they are converted to lower case.</em>
5478 *
5479 * @param data The Uri of the data this intent is now targeting.
5480 * @param type The MIME type of the data being handled by this intent.
5481 *
5482 * @return Returns the same Intent object, for chaining multiple calls
5483 * into a single statement.
5484 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005485 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005486 * @see #setData
5487 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005488 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005489 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005490 */
5491 public Intent setDataAndType(Uri data, String type) {
5492 mData = data;
5493 mType = type;
5494 return this;
5495 }
5496
5497 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005498 * (Usually optional) Normalize and set both the data Uri and an explicit
5499 * MIME data type. This method should very rarely be used -- it allows you
5500 * to override the MIME type that would ordinarily be inferred from the
5501 * data with your own type given here.
5502 *
5503 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005504 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005505 * before they are set, so really this is just a convenience method for
5506 * <pre>
5507 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5508 * </pre>
5509 *
5510 * @param data The Uri of the data this intent is now targeting.
5511 * @param type The MIME type of the data being handled by this intent.
5512 *
5513 * @return Returns the same Intent object, for chaining multiple calls
5514 * into a single statement.
5515 *
5516 * @see #setType
5517 * @see #setData
5518 * @see #setDataAndType
5519 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005520 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005521 */
5522 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005523 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005524 }
5525
5526 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005527 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005528 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005529 * activities that provide <em>all</em> of the requested categories will be
5530 * used.
5531 *
5532 * @param category The desired category. This can be either one of the
5533 * predefined Intent categories, or a custom category in your own
5534 * namespace.
5535 *
5536 * @return Returns the same Intent object, for chaining multiple calls
5537 * into a single statement.
5538 *
5539 * @see #hasCategory
5540 * @see #removeCategory
5541 */
5542 public Intent addCategory(String category) {
5543 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005544 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005545 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005546 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005547 return this;
5548 }
5549
5550 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005551 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005552 *
5553 * @param category The category to remove.
5554 *
5555 * @see #addCategory
5556 */
5557 public void removeCategory(String category) {
5558 if (mCategories != null) {
5559 mCategories.remove(category);
5560 if (mCategories.size() == 0) {
5561 mCategories = null;
5562 }
5563 }
5564 }
5565
5566 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005567 * Set a selector for this Intent. This is a modification to the kinds of
5568 * things the Intent will match. If the selector is set, it will be used
5569 * when trying to find entities that can handle the Intent, instead of the
5570 * main contents of the Intent. This allows you build an Intent containing
5571 * a generic protocol while targeting it more specifically.
5572 *
5573 * <p>An example of where this may be used is with things like
5574 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5575 * Intent that will launch the Browser application. However, the correct
5576 * main entry point of an application is actually {@link #ACTION_MAIN}
5577 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5578 * used to specify the actual Activity to launch. If you launch the browser
5579 * with something different, undesired behavior may happen if the user has
5580 * previously or later launches it the normal way, since they do not match.
5581 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5582 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5583 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5584 *
5585 * <p>Setting a selector does not impact the behavior of
5586 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5587 * desired behavior of a selector -- it does not impact the base meaning
5588 * of the Intent, just what kinds of things will be matched against it
5589 * when determining who can handle it.</p>
5590 *
5591 * <p>You can not use both a selector and {@link #setPackage(String)} on
5592 * the same base Intent.</p>
5593 *
5594 * @param selector The desired selector Intent; set to null to not use
5595 * a special selector.
5596 */
5597 public void setSelector(Intent selector) {
5598 if (selector == this) {
5599 throw new IllegalArgumentException(
5600 "Intent being set as a selector of itself");
5601 }
5602 if (selector != null && mPackage != null) {
5603 throw new IllegalArgumentException(
5604 "Can't set selector when package name is already set");
5605 }
5606 mSelector = selector;
5607 }
5608
5609 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005610 * Set a {@link ClipData} associated with this Intent. This replaces any
5611 * previously set ClipData.
5612 *
5613 * <p>The ClipData in an intent is not used for Intent matching or other
5614 * such operations. Semantically it is like extras, used to transmit
5615 * additional data with the Intent. The main feature of using this over
5616 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5617 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5618 * items included in the clip data. This is useful, in particular, if
5619 * you want to transmit an Intent containing multiple <code>content:</code>
5620 * URIs for which the recipient may not have global permission to access the
5621 * content provider.
5622 *
5623 * <p>If the ClipData contains items that are themselves Intents, any
5624 * grant flags in those Intents will be ignored. Only the top-level flags
5625 * of the main Intent are respected, and will be applied to all Uri or
5626 * Intent items in the clip (or sub-items of the clip).
5627 *
5628 * <p>The MIME type, label, and icon in the ClipData object are not
5629 * directly used by Intent. Applications should generally rely on the
5630 * MIME type of the Intent itself, not what it may find in the ClipData.
5631 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005632 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005633 *
5634 * @param clip The new clip to set. May be null to clear the current clip.
5635 */
5636 public void setClipData(ClipData clip) {
5637 mClipData = clip;
5638 }
5639
5640 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005641 * Add extended data to the intent. The name must include a package
5642 * prefix, for example the app com.android.contacts would use names
5643 * like "com.android.contacts.ShowAll".
5644 *
5645 * @param name The name of the extra data, with package prefix.
5646 * @param value The boolean data value.
5647 *
5648 * @return Returns the same Intent object, for chaining multiple calls
5649 * into a single statement.
5650 *
5651 * @see #putExtras
5652 * @see #removeExtra
5653 * @see #getBooleanExtra(String, boolean)
5654 */
5655 public Intent putExtra(String name, boolean value) {
5656 if (mExtras == null) {
5657 mExtras = new Bundle();
5658 }
5659 mExtras.putBoolean(name, value);
5660 return this;
5661 }
5662
5663 /**
5664 * Add extended data to the intent. The name must include a package
5665 * prefix, for example the app com.android.contacts would use names
5666 * like "com.android.contacts.ShowAll".
5667 *
5668 * @param name The name of the extra data, with package prefix.
5669 * @param value The byte data value.
5670 *
5671 * @return Returns the same Intent object, for chaining multiple calls
5672 * into a single statement.
5673 *
5674 * @see #putExtras
5675 * @see #removeExtra
5676 * @see #getByteExtra(String, byte)
5677 */
5678 public Intent putExtra(String name, byte value) {
5679 if (mExtras == null) {
5680 mExtras = new Bundle();
5681 }
5682 mExtras.putByte(name, value);
5683 return this;
5684 }
5685
5686 /**
5687 * Add extended data to the intent. The name must include a package
5688 * prefix, for example the app com.android.contacts would use names
5689 * like "com.android.contacts.ShowAll".
5690 *
5691 * @param name The name of the extra data, with package prefix.
5692 * @param value The char data value.
5693 *
5694 * @return Returns the same Intent object, for chaining multiple calls
5695 * into a single statement.
5696 *
5697 * @see #putExtras
5698 * @see #removeExtra
5699 * @see #getCharExtra(String, char)
5700 */
5701 public Intent putExtra(String name, char value) {
5702 if (mExtras == null) {
5703 mExtras = new Bundle();
5704 }
5705 mExtras.putChar(name, value);
5706 return this;
5707 }
5708
5709 /**
5710 * Add extended data to the intent. The name must include a package
5711 * prefix, for example the app com.android.contacts would use names
5712 * like "com.android.contacts.ShowAll".
5713 *
5714 * @param name The name of the extra data, with package prefix.
5715 * @param value The short data value.
5716 *
5717 * @return Returns the same Intent object, for chaining multiple calls
5718 * into a single statement.
5719 *
5720 * @see #putExtras
5721 * @see #removeExtra
5722 * @see #getShortExtra(String, short)
5723 */
5724 public Intent putExtra(String name, short value) {
5725 if (mExtras == null) {
5726 mExtras = new Bundle();
5727 }
5728 mExtras.putShort(name, value);
5729 return this;
5730 }
5731
5732 /**
5733 * Add extended data to the intent. The name must include a package
5734 * prefix, for example the app com.android.contacts would use names
5735 * like "com.android.contacts.ShowAll".
5736 *
5737 * @param name The name of the extra data, with package prefix.
5738 * @param value The integer data value.
5739 *
5740 * @return Returns the same Intent object, for chaining multiple calls
5741 * into a single statement.
5742 *
5743 * @see #putExtras
5744 * @see #removeExtra
5745 * @see #getIntExtra(String, int)
5746 */
5747 public Intent putExtra(String name, int value) {
5748 if (mExtras == null) {
5749 mExtras = new Bundle();
5750 }
5751 mExtras.putInt(name, value);
5752 return this;
5753 }
5754
5755 /**
5756 * Add extended data to the intent. The name must include a package
5757 * prefix, for example the app com.android.contacts would use names
5758 * like "com.android.contacts.ShowAll".
5759 *
5760 * @param name The name of the extra data, with package prefix.
5761 * @param value The long data value.
5762 *
5763 * @return Returns the same Intent object, for chaining multiple calls
5764 * into a single statement.
5765 *
5766 * @see #putExtras
5767 * @see #removeExtra
5768 * @see #getLongExtra(String, long)
5769 */
5770 public Intent putExtra(String name, long value) {
5771 if (mExtras == null) {
5772 mExtras = new Bundle();
5773 }
5774 mExtras.putLong(name, value);
5775 return this;
5776 }
5777
5778 /**
5779 * Add extended data to the intent. The name must include a package
5780 * prefix, for example the app com.android.contacts would use names
5781 * like "com.android.contacts.ShowAll".
5782 *
5783 * @param name The name of the extra data, with package prefix.
5784 * @param value The float data value.
5785 *
5786 * @return Returns the same Intent object, for chaining multiple calls
5787 * into a single statement.
5788 *
5789 * @see #putExtras
5790 * @see #removeExtra
5791 * @see #getFloatExtra(String, float)
5792 */
5793 public Intent putExtra(String name, float value) {
5794 if (mExtras == null) {
5795 mExtras = new Bundle();
5796 }
5797 mExtras.putFloat(name, value);
5798 return this;
5799 }
5800
5801 /**
5802 * Add extended data to the intent. The name must include a package
5803 * prefix, for example the app com.android.contacts would use names
5804 * like "com.android.contacts.ShowAll".
5805 *
5806 * @param name The name of the extra data, with package prefix.
5807 * @param value The double data value.
5808 *
5809 * @return Returns the same Intent object, for chaining multiple calls
5810 * into a single statement.
5811 *
5812 * @see #putExtras
5813 * @see #removeExtra
5814 * @see #getDoubleExtra(String, double)
5815 */
5816 public Intent putExtra(String name, double value) {
5817 if (mExtras == null) {
5818 mExtras = new Bundle();
5819 }
5820 mExtras.putDouble(name, value);
5821 return this;
5822 }
5823
5824 /**
5825 * Add extended data to the intent. The name must include a package
5826 * prefix, for example the app com.android.contacts would use names
5827 * like "com.android.contacts.ShowAll".
5828 *
5829 * @param name The name of the extra data, with package prefix.
5830 * @param value The String data value.
5831 *
5832 * @return Returns the same Intent object, for chaining multiple calls
5833 * into a single statement.
5834 *
5835 * @see #putExtras
5836 * @see #removeExtra
5837 * @see #getStringExtra(String)
5838 */
5839 public Intent putExtra(String name, String value) {
5840 if (mExtras == null) {
5841 mExtras = new Bundle();
5842 }
5843 mExtras.putString(name, value);
5844 return this;
5845 }
5846
5847 /**
5848 * Add extended data to the intent. The name must include a package
5849 * prefix, for example the app com.android.contacts would use names
5850 * like "com.android.contacts.ShowAll".
5851 *
5852 * @param name The name of the extra data, with package prefix.
5853 * @param value The CharSequence data value.
5854 *
5855 * @return Returns the same Intent object, for chaining multiple calls
5856 * into a single statement.
5857 *
5858 * @see #putExtras
5859 * @see #removeExtra
5860 * @see #getCharSequenceExtra(String)
5861 */
5862 public Intent putExtra(String name, CharSequence value) {
5863 if (mExtras == null) {
5864 mExtras = new Bundle();
5865 }
5866 mExtras.putCharSequence(name, value);
5867 return this;
5868 }
5869
5870 /**
5871 * Add extended data to the intent. The name must include a package
5872 * prefix, for example the app com.android.contacts would use names
5873 * like "com.android.contacts.ShowAll".
5874 *
5875 * @param name The name of the extra data, with package prefix.
5876 * @param value The Parcelable data value.
5877 *
5878 * @return Returns the same Intent object, for chaining multiple calls
5879 * into a single statement.
5880 *
5881 * @see #putExtras
5882 * @see #removeExtra
5883 * @see #getParcelableExtra(String)
5884 */
5885 public Intent putExtra(String name, Parcelable value) {
5886 if (mExtras == null) {
5887 mExtras = new Bundle();
5888 }
5889 mExtras.putParcelable(name, value);
5890 return this;
5891 }
5892
5893 /**
5894 * Add extended data to the intent. The name must include a package
5895 * prefix, for example the app com.android.contacts would use names
5896 * like "com.android.contacts.ShowAll".
5897 *
5898 * @param name The name of the extra data, with package prefix.
5899 * @param value The Parcelable[] data value.
5900 *
5901 * @return Returns the same Intent object, for chaining multiple calls
5902 * into a single statement.
5903 *
5904 * @see #putExtras
5905 * @see #removeExtra
5906 * @see #getParcelableArrayExtra(String)
5907 */
5908 public Intent putExtra(String name, Parcelable[] value) {
5909 if (mExtras == null) {
5910 mExtras = new Bundle();
5911 }
5912 mExtras.putParcelableArray(name, value);
5913 return this;
5914 }
5915
5916 /**
5917 * Add extended data to the intent. The name must include a package
5918 * prefix, for example the app com.android.contacts would use names
5919 * like "com.android.contacts.ShowAll".
5920 *
5921 * @param name The name of the extra data, with package prefix.
5922 * @param value The ArrayList<Parcelable> data value.
5923 *
5924 * @return Returns the same Intent object, for chaining multiple calls
5925 * into a single statement.
5926 *
5927 * @see #putExtras
5928 * @see #removeExtra
5929 * @see #getParcelableArrayListExtra(String)
5930 */
5931 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5932 if (mExtras == null) {
5933 mExtras = new Bundle();
5934 }
5935 mExtras.putParcelableArrayList(name, value);
5936 return this;
5937 }
5938
5939 /**
5940 * Add extended data to the intent. The name must include a package
5941 * prefix, for example the app com.android.contacts would use names
5942 * like "com.android.contacts.ShowAll".
5943 *
5944 * @param name The name of the extra data, with package prefix.
5945 * @param value The ArrayList<Integer> data value.
5946 *
5947 * @return Returns the same Intent object, for chaining multiple calls
5948 * into a single statement.
5949 *
5950 * @see #putExtras
5951 * @see #removeExtra
5952 * @see #getIntegerArrayListExtra(String)
5953 */
5954 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5955 if (mExtras == null) {
5956 mExtras = new Bundle();
5957 }
5958 mExtras.putIntegerArrayList(name, value);
5959 return this;
5960 }
5961
5962 /**
5963 * Add extended data to the intent. The name must include a package
5964 * prefix, for example the app com.android.contacts would use names
5965 * like "com.android.contacts.ShowAll".
5966 *
5967 * @param name The name of the extra data, with package prefix.
5968 * @param value The ArrayList<String> data value.
5969 *
5970 * @return Returns the same Intent object, for chaining multiple calls
5971 * into a single statement.
5972 *
5973 * @see #putExtras
5974 * @see #removeExtra
5975 * @see #getStringArrayListExtra(String)
5976 */
5977 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5978 if (mExtras == null) {
5979 mExtras = new Bundle();
5980 }
5981 mExtras.putStringArrayList(name, value);
5982 return this;
5983 }
5984
5985 /**
5986 * Add extended data to the intent. The name must include a package
5987 * prefix, for example the app com.android.contacts would use names
5988 * like "com.android.contacts.ShowAll".
5989 *
5990 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005991 * @param value The ArrayList<CharSequence> data value.
5992 *
5993 * @return Returns the same Intent object, for chaining multiple calls
5994 * into a single statement.
5995 *
5996 * @see #putExtras
5997 * @see #removeExtra
5998 * @see #getCharSequenceArrayListExtra(String)
5999 */
6000 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6001 if (mExtras == null) {
6002 mExtras = new Bundle();
6003 }
6004 mExtras.putCharSequenceArrayList(name, value);
6005 return this;
6006 }
6007
6008 /**
6009 * Add extended data to the intent. The name must include a package
6010 * prefix, for example the app com.android.contacts would use names
6011 * like "com.android.contacts.ShowAll".
6012 *
6013 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006014 * @param value The Serializable data value.
6015 *
6016 * @return Returns the same Intent object, for chaining multiple calls
6017 * into a single statement.
6018 *
6019 * @see #putExtras
6020 * @see #removeExtra
6021 * @see #getSerializableExtra(String)
6022 */
6023 public Intent putExtra(String name, Serializable value) {
6024 if (mExtras == null) {
6025 mExtras = new Bundle();
6026 }
6027 mExtras.putSerializable(name, value);
6028 return this;
6029 }
6030
6031 /**
6032 * Add extended data to the intent. The name must include a package
6033 * prefix, for example the app com.android.contacts would use names
6034 * like "com.android.contacts.ShowAll".
6035 *
6036 * @param name The name of the extra data, with package prefix.
6037 * @param value The boolean array data value.
6038 *
6039 * @return Returns the same Intent object, for chaining multiple calls
6040 * into a single statement.
6041 *
6042 * @see #putExtras
6043 * @see #removeExtra
6044 * @see #getBooleanArrayExtra(String)
6045 */
6046 public Intent putExtra(String name, boolean[] value) {
6047 if (mExtras == null) {
6048 mExtras = new Bundle();
6049 }
6050 mExtras.putBooleanArray(name, value);
6051 return this;
6052 }
6053
6054 /**
6055 * Add extended data to the intent. The name must include a package
6056 * prefix, for example the app com.android.contacts would use names
6057 * like "com.android.contacts.ShowAll".
6058 *
6059 * @param name The name of the extra data, with package prefix.
6060 * @param value The byte array data value.
6061 *
6062 * @return Returns the same Intent object, for chaining multiple calls
6063 * into a single statement.
6064 *
6065 * @see #putExtras
6066 * @see #removeExtra
6067 * @see #getByteArrayExtra(String)
6068 */
6069 public Intent putExtra(String name, byte[] value) {
6070 if (mExtras == null) {
6071 mExtras = new Bundle();
6072 }
6073 mExtras.putByteArray(name, value);
6074 return this;
6075 }
6076
6077 /**
6078 * Add extended data to the intent. The name must include a package
6079 * prefix, for example the app com.android.contacts would use names
6080 * like "com.android.contacts.ShowAll".
6081 *
6082 * @param name The name of the extra data, with package prefix.
6083 * @param value The short array data value.
6084 *
6085 * @return Returns the same Intent object, for chaining multiple calls
6086 * into a single statement.
6087 *
6088 * @see #putExtras
6089 * @see #removeExtra
6090 * @see #getShortArrayExtra(String)
6091 */
6092 public Intent putExtra(String name, short[] value) {
6093 if (mExtras == null) {
6094 mExtras = new Bundle();
6095 }
6096 mExtras.putShortArray(name, value);
6097 return this;
6098 }
6099
6100 /**
6101 * Add extended data to the intent. The name must include a package
6102 * prefix, for example the app com.android.contacts would use names
6103 * like "com.android.contacts.ShowAll".
6104 *
6105 * @param name The name of the extra data, with package prefix.
6106 * @param value The char array data value.
6107 *
6108 * @return Returns the same Intent object, for chaining multiple calls
6109 * into a single statement.
6110 *
6111 * @see #putExtras
6112 * @see #removeExtra
6113 * @see #getCharArrayExtra(String)
6114 */
6115 public Intent putExtra(String name, char[] value) {
6116 if (mExtras == null) {
6117 mExtras = new Bundle();
6118 }
6119 mExtras.putCharArray(name, value);
6120 return this;
6121 }
6122
6123 /**
6124 * Add extended data to the intent. The name must include a package
6125 * prefix, for example the app com.android.contacts would use names
6126 * like "com.android.contacts.ShowAll".
6127 *
6128 * @param name The name of the extra data, with package prefix.
6129 * @param value The int array data value.
6130 *
6131 * @return Returns the same Intent object, for chaining multiple calls
6132 * into a single statement.
6133 *
6134 * @see #putExtras
6135 * @see #removeExtra
6136 * @see #getIntArrayExtra(String)
6137 */
6138 public Intent putExtra(String name, int[] value) {
6139 if (mExtras == null) {
6140 mExtras = new Bundle();
6141 }
6142 mExtras.putIntArray(name, value);
6143 return this;
6144 }
6145
6146 /**
6147 * Add extended data to the intent. The name must include a package
6148 * prefix, for example the app com.android.contacts would use names
6149 * like "com.android.contacts.ShowAll".
6150 *
6151 * @param name The name of the extra data, with package prefix.
6152 * @param value The byte array data value.
6153 *
6154 * @return Returns the same Intent object, for chaining multiple calls
6155 * into a single statement.
6156 *
6157 * @see #putExtras
6158 * @see #removeExtra
6159 * @see #getLongArrayExtra(String)
6160 */
6161 public Intent putExtra(String name, long[] value) {
6162 if (mExtras == null) {
6163 mExtras = new Bundle();
6164 }
6165 mExtras.putLongArray(name, value);
6166 return this;
6167 }
6168
6169 /**
6170 * Add extended data to the intent. The name must include a package
6171 * prefix, for example the app com.android.contacts would use names
6172 * like "com.android.contacts.ShowAll".
6173 *
6174 * @param name The name of the extra data, with package prefix.
6175 * @param value The float array data value.
6176 *
6177 * @return Returns the same Intent object, for chaining multiple calls
6178 * into a single statement.
6179 *
6180 * @see #putExtras
6181 * @see #removeExtra
6182 * @see #getFloatArrayExtra(String)
6183 */
6184 public Intent putExtra(String name, float[] value) {
6185 if (mExtras == null) {
6186 mExtras = new Bundle();
6187 }
6188 mExtras.putFloatArray(name, value);
6189 return this;
6190 }
6191
6192 /**
6193 * Add extended data to the intent. The name must include a package
6194 * prefix, for example the app com.android.contacts would use names
6195 * like "com.android.contacts.ShowAll".
6196 *
6197 * @param name The name of the extra data, with package prefix.
6198 * @param value The double array data value.
6199 *
6200 * @return Returns the same Intent object, for chaining multiple calls
6201 * into a single statement.
6202 *
6203 * @see #putExtras
6204 * @see #removeExtra
6205 * @see #getDoubleArrayExtra(String)
6206 */
6207 public Intent putExtra(String name, double[] value) {
6208 if (mExtras == null) {
6209 mExtras = new Bundle();
6210 }
6211 mExtras.putDoubleArray(name, value);
6212 return this;
6213 }
6214
6215 /**
6216 * Add extended data to the intent. The name must include a package
6217 * prefix, for example the app com.android.contacts would use names
6218 * like "com.android.contacts.ShowAll".
6219 *
6220 * @param name The name of the extra data, with package prefix.
6221 * @param value The String array data value.
6222 *
6223 * @return Returns the same Intent object, for chaining multiple calls
6224 * into a single statement.
6225 *
6226 * @see #putExtras
6227 * @see #removeExtra
6228 * @see #getStringArrayExtra(String)
6229 */
6230 public Intent putExtra(String name, String[] value) {
6231 if (mExtras == null) {
6232 mExtras = new Bundle();
6233 }
6234 mExtras.putStringArray(name, value);
6235 return this;
6236 }
6237
6238 /**
6239 * Add extended data to the intent. The name must include a package
6240 * prefix, for example the app com.android.contacts would use names
6241 * like "com.android.contacts.ShowAll".
6242 *
6243 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006244 * @param value The CharSequence array data value.
6245 *
6246 * @return Returns the same Intent object, for chaining multiple calls
6247 * into a single statement.
6248 *
6249 * @see #putExtras
6250 * @see #removeExtra
6251 * @see #getCharSequenceArrayExtra(String)
6252 */
6253 public Intent putExtra(String name, CharSequence[] value) {
6254 if (mExtras == null) {
6255 mExtras = new Bundle();
6256 }
6257 mExtras.putCharSequenceArray(name, value);
6258 return this;
6259 }
6260
6261 /**
6262 * Add extended data to the intent. The name must include a package
6263 * prefix, for example the app com.android.contacts would use names
6264 * like "com.android.contacts.ShowAll".
6265 *
6266 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006267 * @param value The Bundle data value.
6268 *
6269 * @return Returns the same Intent object, for chaining multiple calls
6270 * into a single statement.
6271 *
6272 * @see #putExtras
6273 * @see #removeExtra
6274 * @see #getBundleExtra(String)
6275 */
6276 public Intent putExtra(String name, Bundle value) {
6277 if (mExtras == null) {
6278 mExtras = new Bundle();
6279 }
6280 mExtras.putBundle(name, value);
6281 return this;
6282 }
6283
6284 /**
6285 * Add extended data to the intent. The name must include a package
6286 * prefix, for example the app com.android.contacts would use names
6287 * like "com.android.contacts.ShowAll".
6288 *
6289 * @param name The name of the extra data, with package prefix.
6290 * @param value The IBinder data value.
6291 *
6292 * @return Returns the same Intent object, for chaining multiple calls
6293 * into a single statement.
6294 *
6295 * @see #putExtras
6296 * @see #removeExtra
6297 * @see #getIBinderExtra(String)
6298 *
6299 * @deprecated
6300 * @hide
6301 */
6302 @Deprecated
6303 public Intent putExtra(String name, IBinder value) {
6304 if (mExtras == null) {
6305 mExtras = new Bundle();
6306 }
6307 mExtras.putIBinder(name, value);
6308 return this;
6309 }
6310
6311 /**
6312 * Copy all extras in 'src' in to this intent.
6313 *
6314 * @param src Contains the extras to copy.
6315 *
6316 * @see #putExtra
6317 */
6318 public Intent putExtras(Intent src) {
6319 if (src.mExtras != null) {
6320 if (mExtras == null) {
6321 mExtras = new Bundle(src.mExtras);
6322 } else {
6323 mExtras.putAll(src.mExtras);
6324 }
6325 }
6326 return this;
6327 }
6328
6329 /**
6330 * Add a set of extended data to the intent. The keys must include a package
6331 * prefix, for example the app com.android.contacts would use names
6332 * like "com.android.contacts.ShowAll".
6333 *
6334 * @param extras The Bundle of extras to add to this intent.
6335 *
6336 * @see #putExtra
6337 * @see #removeExtra
6338 */
6339 public Intent putExtras(Bundle extras) {
6340 if (mExtras == null) {
6341 mExtras = new Bundle();
6342 }
6343 mExtras.putAll(extras);
6344 return this;
6345 }
6346
6347 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006348 * Completely replace the extras in the Intent with the extras in the
6349 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006350 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006351 * @param src The exact extras contained in this Intent are copied
6352 * into the target intent, replacing any that were previously there.
6353 */
6354 public Intent replaceExtras(Intent src) {
6355 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6356 return this;
6357 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006358
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006359 /**
6360 * Completely replace the extras in the Intent with the given Bundle of
6361 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006362 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006363 * @param extras The new set of extras in the Intent, or null to erase
6364 * all extras.
6365 */
6366 public Intent replaceExtras(Bundle extras) {
6367 mExtras = extras != null ? new Bundle(extras) : null;
6368 return this;
6369 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006370
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006371 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 * Remove extended data from the intent.
6373 *
6374 * @see #putExtra
6375 */
6376 public void removeExtra(String name) {
6377 if (mExtras != null) {
6378 mExtras.remove(name);
6379 if (mExtras.size() == 0) {
6380 mExtras = null;
6381 }
6382 }
6383 }
6384
6385 /**
6386 * Set special flags controlling how this intent is handled. Most values
6387 * here depend on the type of component being executed by the Intent,
6388 * specifically the FLAG_ACTIVITY_* flags are all for use with
6389 * {@link Context#startActivity Context.startActivity()} and the
6390 * FLAG_RECEIVER_* flags are all for use with
6391 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6392 *
Scott Main7aee61f2011-02-08 11:25:01 -08006393 * <p>See the
6394 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6395 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006396 * the behavior of your application.
6397 *
6398 * @param flags The desired flags.
6399 *
6400 * @return Returns the same Intent object, for chaining multiple calls
6401 * into a single statement.
6402 *
6403 * @see #getFlags
6404 * @see #addFlags
6405 *
6406 * @see #FLAG_GRANT_READ_URI_PERMISSION
6407 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006408 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6409 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006410 * @see #FLAG_DEBUG_LOG_RESOLUTION
6411 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006412 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006413 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006414 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006415 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006416 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6417 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006418 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006419 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006420 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006421 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006422 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006424 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006425 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6426 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006427 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006429 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006430 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6431 */
6432 public Intent setFlags(int flags) {
6433 mFlags = flags;
6434 return this;
6435 }
6436
6437 /**
6438 * Add additional flags to the intent (or with existing flags
6439 * value).
6440 *
6441 * @param flags The new flags to set.
6442 *
6443 * @return Returns the same Intent object, for chaining multiple calls
6444 * into a single statement.
6445 *
6446 * @see #setFlags
6447 */
6448 public Intent addFlags(int flags) {
6449 mFlags |= flags;
6450 return this;
6451 }
6452
6453 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006454 * (Usually optional) Set an explicit application package name that limits
6455 * the components this Intent will resolve to. If left to the default
6456 * value of null, all components in all applications will considered.
6457 * If non-null, the Intent can only match the components in the given
6458 * application package.
6459 *
6460 * @param packageName The name of the application package to handle the
6461 * intent, or null to allow any application package.
6462 *
6463 * @return Returns the same Intent object, for chaining multiple calls
6464 * into a single statement.
6465 *
6466 * @see #getPackage
6467 * @see #resolveActivity
6468 */
6469 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006470 if (packageName != null && mSelector != null) {
6471 throw new IllegalArgumentException(
6472 "Can't set package name when selector is already set");
6473 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006474 mPackage = packageName;
6475 return this;
6476 }
6477
6478 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006479 * (Usually optional) Explicitly set the component to handle the intent.
6480 * If left with the default value of null, the system will determine the
6481 * appropriate class to use based on the other fields (action, data,
6482 * type, categories) in the Intent. If this class is defined, the
6483 * specified class will always be used regardless of the other fields. You
6484 * should only set this value when you know you absolutely want a specific
6485 * class to be used; otherwise it is better to let the system find the
6486 * appropriate class so that you will respect the installed applications
6487 * and user preferences.
6488 *
6489 * @param component The name of the application component to handle the
6490 * intent, or null to let the system find one for you.
6491 *
6492 * @return Returns the same Intent object, for chaining multiple calls
6493 * into a single statement.
6494 *
6495 * @see #setClass
6496 * @see #setClassName(Context, String)
6497 * @see #setClassName(String, String)
6498 * @see #getComponent
6499 * @see #resolveActivity
6500 */
6501 public Intent setComponent(ComponentName component) {
6502 mComponent = component;
6503 return this;
6504 }
6505
6506 /**
6507 * Convenience for calling {@link #setComponent} with an
6508 * explicit class name.
6509 *
6510 * @param packageContext A Context of the application package implementing
6511 * this class.
6512 * @param className The name of a class inside of the application package
6513 * that will be used as the component for this Intent.
6514 *
6515 * @return Returns the same Intent object, for chaining multiple calls
6516 * into a single statement.
6517 *
6518 * @see #setComponent
6519 * @see #setClass
6520 */
6521 public Intent setClassName(Context packageContext, String className) {
6522 mComponent = new ComponentName(packageContext, className);
6523 return this;
6524 }
6525
6526 /**
6527 * Convenience for calling {@link #setComponent} with an
6528 * explicit application package name and class name.
6529 *
6530 * @param packageName The name of the package implementing the desired
6531 * component.
6532 * @param className The name of a class inside of the application package
6533 * that will be used as the component for this Intent.
6534 *
6535 * @return Returns the same Intent object, for chaining multiple calls
6536 * into a single statement.
6537 *
6538 * @see #setComponent
6539 * @see #setClass
6540 */
6541 public Intent setClassName(String packageName, String className) {
6542 mComponent = new ComponentName(packageName, className);
6543 return this;
6544 }
6545
6546 /**
6547 * Convenience for calling {@link #setComponent(ComponentName)} with the
6548 * name returned by a {@link Class} object.
6549 *
6550 * @param packageContext A Context of the application package implementing
6551 * this class.
6552 * @param cls The class name to set, equivalent to
6553 * <code>setClassName(context, cls.getName())</code>.
6554 *
6555 * @return Returns the same Intent object, for chaining multiple calls
6556 * into a single statement.
6557 *
6558 * @see #setComponent
6559 */
6560 public Intent setClass(Context packageContext, Class<?> cls) {
6561 mComponent = new ComponentName(packageContext, cls);
6562 return this;
6563 }
6564
6565 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006566 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6567 * used as a hint to the receiver for animations and the like. Null means that there
6568 * is no source bounds.
6569 */
6570 public void setSourceBounds(Rect r) {
6571 if (r != null) {
6572 mSourceBounds = new Rect(r);
6573 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006574 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006575 }
6576 }
6577
Tor Norbyed9273d62013-05-30 15:59:53 -07006578 /** @hide */
6579 @IntDef(flag = true,
6580 value = {
6581 FILL_IN_ACTION,
6582 FILL_IN_DATA,
6583 FILL_IN_CATEGORIES,
6584 FILL_IN_COMPONENT,
6585 FILL_IN_PACKAGE,
6586 FILL_IN_SOURCE_BOUNDS,
6587 FILL_IN_SELECTOR,
6588 FILL_IN_CLIP_DATA
6589 })
6590 @Retention(RetentionPolicy.SOURCE)
6591 public @interface FillInFlags {}
6592
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006593 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006594 * Use with {@link #fillIn} to allow the current action value to be
6595 * overwritten, even if it is already set.
6596 */
6597 public static final int FILL_IN_ACTION = 1<<0;
6598
6599 /**
6600 * Use with {@link #fillIn} to allow the current data or type value
6601 * overwritten, even if it is already set.
6602 */
6603 public static final int FILL_IN_DATA = 1<<1;
6604
6605 /**
6606 * Use with {@link #fillIn} to allow the current categories to be
6607 * overwritten, even if they are already set.
6608 */
6609 public static final int FILL_IN_CATEGORIES = 1<<2;
6610
6611 /**
6612 * Use with {@link #fillIn} to allow the current component value to be
6613 * overwritten, even if it is already set.
6614 */
6615 public static final int FILL_IN_COMPONENT = 1<<3;
6616
6617 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006618 * Use with {@link #fillIn} to allow the current package value to be
6619 * overwritten, even if it is already set.
6620 */
6621 public static final int FILL_IN_PACKAGE = 1<<4;
6622
6623 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006624 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006625 * overwritten, even if it is already set.
6626 */
6627 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6628
6629 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006630 * Use with {@link #fillIn} to allow the current selector to be
6631 * overwritten, even if it is already set.
6632 */
6633 public static final int FILL_IN_SELECTOR = 1<<6;
6634
6635 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006636 * Use with {@link #fillIn} to allow the current ClipData to be
6637 * overwritten, even if it is already set.
6638 */
6639 public static final int FILL_IN_CLIP_DATA = 1<<7;
6640
6641 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006642 * Copy the contents of <var>other</var> in to this object, but only
6643 * where fields are not defined by this object. For purposes of a field
6644 * being defined, the following pieces of data in the Intent are
6645 * considered to be separate fields:
6646 *
6647 * <ul>
6648 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006649 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006650 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6651 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006652 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006653 * <li> component, as set by {@link #setComponent(ComponentName)} or
6654 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006655 * <li> source bounds, as set by {@link #setSourceBounds}.
6656 * <li> selector, as set by {@link #setSelector(Intent)}.
6657 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006658 * <li> each top-level name in the associated extras.
6659 * </ul>
6660 *
6661 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006662 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006663 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6664 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6665 * the restriction where the corresponding field will not be replaced if
6666 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006667 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006668 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6669 * is explicitly specified. The selector will only be copied if
6670 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006671 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006672 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6673 * and Intent B with {action="gotit", data-type="some/thing",
6674 * categories="one","two"}.
6675 *
6676 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6677 * containing: {action="gotit", data-type="some/thing",
6678 * categories="bar"}.
6679 *
6680 * @param other Another Intent whose values are to be used to fill in
6681 * the current one.
6682 * @param flags Options to control which fields can be filled in.
6683 *
6684 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006685 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006686 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6687 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6688 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006689 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006690 @FillInFlags
6691 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006692 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006693 if (other.mAction != null
6694 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006695 mAction = other.mAction;
6696 changes |= FILL_IN_ACTION;
6697 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006698 if ((other.mData != null || other.mType != null)
6699 && ((mData == null && mType == null)
6700 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006701 mData = other.mData;
6702 mType = other.mType;
6703 changes |= FILL_IN_DATA;
6704 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006705 if (other.mCategories != null
6706 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006707 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006708 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006709 }
6710 changes |= FILL_IN_CATEGORIES;
6711 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006712 if (other.mPackage != null
6713 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006714 // Only do this if mSelector is not set.
6715 if (mSelector == null) {
6716 mPackage = other.mPackage;
6717 changes |= FILL_IN_PACKAGE;
6718 }
6719 }
6720 // Selector is special: it can only be set if explicitly allowed,
6721 // for the same reason as the component name.
6722 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6723 if (mPackage == null) {
6724 mSelector = new Intent(other.mSelector);
6725 mPackage = null;
6726 changes |= FILL_IN_SELECTOR;
6727 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006728 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006729 if (other.mClipData != null
6730 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6731 mClipData = other.mClipData;
6732 changes |= FILL_IN_CLIP_DATA;
6733 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006734 // Component is special: it can -only- be set if explicitly allowed,
6735 // since otherwise the sender could force the intent somewhere the
6736 // originator didn't intend.
6737 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006738 mComponent = other.mComponent;
6739 changes |= FILL_IN_COMPONENT;
6740 }
6741 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006742 if (other.mSourceBounds != null
6743 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6744 mSourceBounds = new Rect(other.mSourceBounds);
6745 changes |= FILL_IN_SOURCE_BOUNDS;
6746 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006747 if (mExtras == null) {
6748 if (other.mExtras != null) {
6749 mExtras = new Bundle(other.mExtras);
6750 }
6751 } else if (other.mExtras != null) {
6752 try {
6753 Bundle newb = new Bundle(other.mExtras);
6754 newb.putAll(mExtras);
6755 mExtras = newb;
6756 } catch (RuntimeException e) {
6757 // Modifying the extras can cause us to unparcel the contents
6758 // of the bundle, and if we do this in the system process that
6759 // may fail. We really should handle this (i.e., the Bundle
6760 // impl shouldn't be on top of a plain map), but for now just
6761 // ignore it and keep the original contents. :(
6762 Log.w("Intent", "Failure filling in extras", e);
6763 }
6764 }
6765 return changes;
6766 }
6767
6768 /**
6769 * Wrapper class holding an Intent and implementing comparisons on it for
6770 * the purpose of filtering. The class implements its
6771 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6772 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6773 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6774 * on the wrapped Intent.
6775 */
6776 public static final class FilterComparison {
6777 private final Intent mIntent;
6778 private final int mHashCode;
6779
6780 public FilterComparison(Intent intent) {
6781 mIntent = intent;
6782 mHashCode = intent.filterHashCode();
6783 }
6784
6785 /**
6786 * Return the Intent that this FilterComparison represents.
6787 * @return Returns the Intent held by the FilterComparison. Do
6788 * not modify!
6789 */
6790 public Intent getIntent() {
6791 return mIntent;
6792 }
6793
6794 @Override
6795 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006796 if (obj instanceof FilterComparison) {
6797 Intent other = ((FilterComparison)obj).mIntent;
6798 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006799 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006800 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006801 }
6802
6803 @Override
6804 public int hashCode() {
6805 return mHashCode;
6806 }
6807 }
6808
6809 /**
6810 * Determine if two intents are the same for the purposes of intent
6811 * resolution (filtering). That is, if their action, data, type,
6812 * class, and categories are the same. This does <em>not</em> compare
6813 * any extra data included in the intents.
6814 *
6815 * @param other The other Intent to compare against.
6816 *
6817 * @return Returns true if action, data, type, class, and categories
6818 * are the same.
6819 */
6820 public boolean filterEquals(Intent other) {
6821 if (other == null) {
6822 return false;
6823 }
6824 if (mAction != other.mAction) {
6825 if (mAction != null) {
6826 if (!mAction.equals(other.mAction)) {
6827 return false;
6828 }
6829 } else {
6830 if (!other.mAction.equals(mAction)) {
6831 return false;
6832 }
6833 }
6834 }
6835 if (mData != other.mData) {
6836 if (mData != null) {
6837 if (!mData.equals(other.mData)) {
6838 return false;
6839 }
6840 } else {
6841 if (!other.mData.equals(mData)) {
6842 return false;
6843 }
6844 }
6845 }
6846 if (mType != other.mType) {
6847 if (mType != null) {
6848 if (!mType.equals(other.mType)) {
6849 return false;
6850 }
6851 } else {
6852 if (!other.mType.equals(mType)) {
6853 return false;
6854 }
6855 }
6856 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006857 if (mPackage != other.mPackage) {
6858 if (mPackage != null) {
6859 if (!mPackage.equals(other.mPackage)) {
6860 return false;
6861 }
6862 } else {
6863 if (!other.mPackage.equals(mPackage)) {
6864 return false;
6865 }
6866 }
6867 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006868 if (mComponent != other.mComponent) {
6869 if (mComponent != null) {
6870 if (!mComponent.equals(other.mComponent)) {
6871 return false;
6872 }
6873 } else {
6874 if (!other.mComponent.equals(mComponent)) {
6875 return false;
6876 }
6877 }
6878 }
6879 if (mCategories != other.mCategories) {
6880 if (mCategories != null) {
6881 if (!mCategories.equals(other.mCategories)) {
6882 return false;
6883 }
6884 } else {
6885 if (!other.mCategories.equals(mCategories)) {
6886 return false;
6887 }
6888 }
6889 }
6890
6891 return true;
6892 }
6893
6894 /**
6895 * Generate hash code that matches semantics of filterEquals().
6896 *
6897 * @return Returns the hash value of the action, data, type, class, and
6898 * categories.
6899 *
6900 * @see #filterEquals
6901 */
6902 public int filterHashCode() {
6903 int code = 0;
6904 if (mAction != null) {
6905 code += mAction.hashCode();
6906 }
6907 if (mData != null) {
6908 code += mData.hashCode();
6909 }
6910 if (mType != null) {
6911 code += mType.hashCode();
6912 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006913 if (mPackage != null) {
6914 code += mPackage.hashCode();
6915 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006916 if (mComponent != null) {
6917 code += mComponent.hashCode();
6918 }
6919 if (mCategories != null) {
6920 code += mCategories.hashCode();
6921 }
6922 return code;
6923 }
6924
6925 @Override
6926 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006927 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006928
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006929 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006930 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006931 b.append(" }");
6932
6933 return b.toString();
6934 }
6935
6936 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006937 public String toInsecureString() {
6938 StringBuilder b = new StringBuilder(128);
6939
6940 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006941 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006942 b.append(" }");
6943
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006944 return b.toString();
6945 }
Romain Guy4969af72009-06-17 10:53:19 -07006946
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006947 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006948 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006949 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006950
6951 b.append("Intent { ");
6952 toShortString(b, false, true, true, true);
6953 b.append(" }");
6954
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006955 return b.toString();
6956 }
6957
6958 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006959 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6960 StringBuilder b = new StringBuilder(128);
6961 toShortString(b, secure, comp, extras, clip);
6962 return b.toString();
6963 }
6964
6965 /** @hide */
6966 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6967 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006968 boolean first = true;
6969 if (mAction != null) {
6970 b.append("act=").append(mAction);
6971 first = false;
6972 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006973 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006974 if (!first) {
6975 b.append(' ');
6976 }
6977 first = false;
6978 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006979 for (int i=0; i<mCategories.size(); i++) {
6980 if (i > 0) b.append(',');
6981 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006982 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006983 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006984 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006985 if (mData != null) {
6986 if (!first) {
6987 b.append(' ');
6988 }
6989 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006990 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006991 if (secure) {
6992 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006993 } else {
6994 b.append(mData);
6995 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006996 }
6997 if (mType != null) {
6998 if (!first) {
6999 b.append(' ');
7000 }
7001 first = false;
7002 b.append("typ=").append(mType);
7003 }
7004 if (mFlags != 0) {
7005 if (!first) {
7006 b.append(' ');
7007 }
7008 first = false;
7009 b.append("flg=0x").append(Integer.toHexString(mFlags));
7010 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007011 if (mPackage != null) {
7012 if (!first) {
7013 b.append(' ');
7014 }
7015 first = false;
7016 b.append("pkg=").append(mPackage);
7017 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007018 if (comp && mComponent != null) {
7019 if (!first) {
7020 b.append(' ');
7021 }
7022 first = false;
7023 b.append("cmp=").append(mComponent.flattenToShortString());
7024 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007025 if (mSourceBounds != null) {
7026 if (!first) {
7027 b.append(' ');
7028 }
7029 first = false;
7030 b.append("bnds=").append(mSourceBounds.toShortString());
7031 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007032 if (mClipData != null) {
7033 if (!first) {
7034 b.append(' ');
7035 }
7036 first = false;
7037 if (clip) {
7038 b.append("clip={");
7039 mClipData.toShortString(b);
7040 b.append('}');
7041 } else {
7042 b.append("(has clip)");
7043 }
7044 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007045 if (extras && mExtras != null) {
7046 if (!first) {
7047 b.append(' ');
7048 }
7049 first = false;
7050 b.append("(has extras)");
7051 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007052 if (mSelector != null) {
7053 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007054 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007055 b.append("}");
7056 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007057 }
7058
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007059 /**
7060 * Call {@link #toUri} with 0 flags.
7061 * @deprecated Use {@link #toUri} instead.
7062 */
7063 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007064 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007065 return toUri(0);
7066 }
7067
7068 /**
7069 * Convert this Intent into a String holding a URI representation of it.
7070 * The returned URI string has been properly URI encoded, so it can be
7071 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7072 * Intent's data as the base URI, with an additional fragment describing
7073 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007074 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007075 * <p>You can convert the returned string back to an Intent with
7076 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007077 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007078 * @param flags Additional operating flags. Either 0 or
7079 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007080 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007081 * @return Returns a URI encoding URI string describing the entire contents
7082 * of the Intent.
7083 */
7084 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007085 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007086 String scheme = null;
7087 if (mData != null) {
7088 String data = mData.toString();
7089 if ((flags&URI_INTENT_SCHEME) != 0) {
7090 final int N = data.length();
7091 for (int i=0; i<N; i++) {
7092 char c = data.charAt(i);
7093 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7094 || c == '.' || c == '-') {
7095 continue;
7096 }
7097 if (c == ':' && i > 0) {
7098 // Valid scheme.
7099 scheme = data.substring(0, i);
7100 uri.append("intent:");
7101 data = data.substring(i+1);
7102 break;
7103 }
Tom Taylord4a47292009-12-21 13:59:18 -08007104
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007105 // No scheme.
7106 break;
7107 }
7108 }
7109 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007110
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007111 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7112 uri.append("intent:");
7113 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007114
7115 uri.append("#Intent;");
7116
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007117 toUriInner(uri, scheme, flags);
7118 if (mSelector != null) {
7119 uri.append("SEL;");
7120 // Note that for now we are not going to try to handle the
7121 // data part; not clear how to represent this as a URI, and
7122 // not much utility in it.
7123 mSelector.toUriInner(uri, null, flags);
7124 }
7125
7126 uri.append("end");
7127
7128 return uri.toString();
7129 }
7130
7131 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007132 if (scheme != null) {
7133 uri.append("scheme=").append(scheme).append(';');
7134 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007135 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007136 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007137 }
7138 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007139 for (int i=0; i<mCategories.size(); i++) {
7140 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007141 }
7142 }
7143 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007144 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007145 }
7146 if (mFlags != 0) {
7147 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7148 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007149 if (mPackage != null) {
7150 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7151 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007152 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007153 uri.append("component=").append(Uri.encode(
7154 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007155 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007156 if (mSourceBounds != null) {
7157 uri.append("sourceBounds=")
7158 .append(Uri.encode(mSourceBounds.flattenToString()))
7159 .append(';');
7160 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007161 if (mExtras != null) {
7162 for (String key : mExtras.keySet()) {
7163 final Object value = mExtras.get(key);
7164 char entryType =
7165 value instanceof String ? 'S' :
7166 value instanceof Boolean ? 'B' :
7167 value instanceof Byte ? 'b' :
7168 value instanceof Character ? 'c' :
7169 value instanceof Double ? 'd' :
7170 value instanceof Float ? 'f' :
7171 value instanceof Integer ? 'i' :
7172 value instanceof Long ? 'l' :
7173 value instanceof Short ? 's' :
7174 '\0';
7175
7176 if (entryType != '\0') {
7177 uri.append(entryType);
7178 uri.append('.');
7179 uri.append(Uri.encode(key));
7180 uri.append('=');
7181 uri.append(Uri.encode(value.toString()));
7182 uri.append(';');
7183 }
7184 }
7185 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007186 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007187
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007188 public int describeContents() {
7189 return (mExtras != null) ? mExtras.describeContents() : 0;
7190 }
7191
7192 public void writeToParcel(Parcel out, int flags) {
7193 out.writeString(mAction);
7194 Uri.writeToParcel(out, mData);
7195 out.writeString(mType);
7196 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007197 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007198 ComponentName.writeToParcel(mComponent, out);
7199
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007200 if (mSourceBounds != null) {
7201 out.writeInt(1);
7202 mSourceBounds.writeToParcel(out, flags);
7203 } else {
7204 out.writeInt(0);
7205 }
7206
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007208 final int N = mCategories.size();
7209 out.writeInt(N);
7210 for (int i=0; i<N; i++) {
7211 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007212 }
7213 } else {
7214 out.writeInt(0);
7215 }
7216
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007217 if (mSelector != null) {
7218 out.writeInt(1);
7219 mSelector.writeToParcel(out, flags);
7220 } else {
7221 out.writeInt(0);
7222 }
7223
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007224 if (mClipData != null) {
7225 out.writeInt(1);
7226 mClipData.writeToParcel(out, flags);
7227 } else {
7228 out.writeInt(0);
7229 }
7230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007231 out.writeBundle(mExtras);
7232 }
7233
7234 public static final Parcelable.Creator<Intent> CREATOR
7235 = new Parcelable.Creator<Intent>() {
7236 public Intent createFromParcel(Parcel in) {
7237 return new Intent(in);
7238 }
7239 public Intent[] newArray(int size) {
7240 return new Intent[size];
7241 }
7242 };
7243
Dianne Hackborneb034652009-09-07 00:49:58 -07007244 /** @hide */
7245 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007246 readFromParcel(in);
7247 }
7248
7249 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007250 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007251 mData = Uri.CREATOR.createFromParcel(in);
7252 mType = in.readString();
7253 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007254 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007255 mComponent = ComponentName.readFromParcel(in);
7256
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007257 if (in.readInt() != 0) {
7258 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7259 }
7260
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007261 int N = in.readInt();
7262 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007263 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007264 int i;
7265 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007266 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007267 }
7268 } else {
7269 mCategories = null;
7270 }
7271
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007272 if (in.readInt() != 0) {
7273 mSelector = new Intent(in);
7274 }
7275
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007276 if (in.readInt() != 0) {
7277 mClipData = new ClipData(in);
7278 }
7279
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007280 mExtras = in.readBundle();
7281 }
7282
7283 /**
7284 * Parses the "intent" element (and its children) from XML and instantiates
7285 * an Intent object. The given XML parser should be located at the tag
7286 * where parsing should start (often named "intent"), from which the
7287 * basic action, data, type, and package and class name will be
7288 * retrieved. The function will then parse in to any child elements,
7289 * looking for <category android:name="xxx"> tags to add categories and
7290 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7291 * to the intent.
7292 *
7293 * @param resources The Resources to use when inflating resources.
7294 * @param parser The XML parser pointing at an "intent" tag.
7295 * @param attrs The AttributeSet interface for retrieving extended
7296 * attribute data at the current <var>parser</var> location.
7297 * @return An Intent object matching the XML data.
7298 * @throws XmlPullParserException If there was an XML parsing error.
7299 * @throws IOException If there was an I/O error.
7300 */
7301 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7302 throws XmlPullParserException, IOException {
7303 Intent intent = new Intent();
7304
7305 TypedArray sa = resources.obtainAttributes(attrs,
7306 com.android.internal.R.styleable.Intent);
7307
7308 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7309
7310 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7311 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7312 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7313
7314 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7315 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7316 if (packageName != null && className != null) {
7317 intent.setComponent(new ComponentName(packageName, className));
7318 }
7319
7320 sa.recycle();
7321
7322 int outerDepth = parser.getDepth();
7323 int type;
7324 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7325 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7326 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7327 continue;
7328 }
7329
7330 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007331 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007332 sa = resources.obtainAttributes(attrs,
7333 com.android.internal.R.styleable.IntentCategory);
7334 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7335 sa.recycle();
7336
7337 if (cat != null) {
7338 intent.addCategory(cat);
7339 }
7340 XmlUtils.skipCurrentTag(parser);
7341
Craig Mautner21d24a22014-04-23 11:45:37 -07007342 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007343 if (intent.mExtras == null) {
7344 intent.mExtras = new Bundle();
7345 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007346 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007347 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007348
7349 } else {
7350 XmlUtils.skipCurrentTag(parser);
7351 }
7352 }
7353
7354 return intent;
7355 }
Nick Pellyccae4122012-01-09 14:12:58 -08007356
Craig Mautner21d24a22014-04-23 11:45:37 -07007357 /** @hide */
7358 public void saveToXml(XmlSerializer out) throws IOException {
7359 if (mAction != null) {
7360 out.attribute(null, ATTR_ACTION, mAction);
7361 }
7362 if (mData != null) {
7363 out.attribute(null, ATTR_DATA, mData.toString());
7364 }
7365 if (mType != null) {
7366 out.attribute(null, ATTR_TYPE, mType);
7367 }
7368 if (mComponent != null) {
7369 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7370 }
7371 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7372
7373 if (mCategories != null) {
7374 out.startTag(null, TAG_CATEGORIES);
7375 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7376 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7377 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007378 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007379 }
7380 }
7381
7382 /** @hide */
7383 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7384 XmlPullParserException {
7385 Intent intent = new Intent();
7386 final int outerDepth = in.getDepth();
7387
7388 int attrCount = in.getAttributeCount();
7389 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7390 final String attrName = in.getAttributeName(attrNdx);
7391 final String attrValue = in.getAttributeValue(attrNdx);
7392 if (ATTR_ACTION.equals(attrName)) {
7393 intent.setAction(attrValue);
7394 } else if (ATTR_DATA.equals(attrName)) {
7395 intent.setData(Uri.parse(attrValue));
7396 } else if (ATTR_TYPE.equals(attrName)) {
7397 intent.setType(attrValue);
7398 } else if (ATTR_COMPONENT.equals(attrName)) {
7399 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7400 } else if (ATTR_FLAGS.equals(attrName)) {
7401 intent.setFlags(Integer.valueOf(attrValue, 16));
7402 } else {
7403 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7404 }
7405 }
7406
7407 int event;
7408 String name;
7409 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7410 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7411 if (event == XmlPullParser.START_TAG) {
7412 name = in.getName();
7413 if (TAG_CATEGORIES.equals(name)) {
7414 attrCount = in.getAttributeCount();
7415 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7416 intent.addCategory(in.getAttributeValue(attrNdx));
7417 }
7418 } else {
7419 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7420 XmlUtils.skipCurrentTag(in);
7421 }
7422 }
7423 }
7424
7425 return intent;
7426 }
7427
Nick Pellyccae4122012-01-09 14:12:58 -08007428 /**
7429 * Normalize a MIME data type.
7430 *
7431 * <p>A normalized MIME type has white-space trimmed,
7432 * content-type parameters removed, and is lower-case.
7433 * This aligns the type with Android best practices for
7434 * intent filtering.
7435 *
7436 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7437 * "text/x-vCard" becomes "text/x-vcard".
7438 *
7439 * <p>All MIME types received from outside Android (such as user input,
7440 * or external sources like Bluetooth, NFC, or the Internet) should
7441 * be normalized before they are used to create an Intent.
7442 *
7443 * @param type MIME data type to normalize
7444 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007445 * @see #setType
7446 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007447 */
7448 public static String normalizeMimeType(String type) {
7449 if (type == null) {
7450 return null;
7451 }
7452
Elliott Hughescb64d432013-08-02 10:00:44 -07007453 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007454
7455 final int semicolonIndex = type.indexOf(';');
7456 if (semicolonIndex != -1) {
7457 type = type.substring(0, semicolonIndex);
7458 }
7459 return type;
7460 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007461
7462 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007463 * Prepare this {@link Intent} to leave an app process.
7464 *
7465 * @hide
7466 */
7467 public void prepareToLeaveProcess() {
7468 setAllowFds(false);
7469
7470 if (mSelector != null) {
7471 mSelector.prepareToLeaveProcess();
7472 }
7473 if (mClipData != null) {
7474 mClipData.prepareToLeaveProcess();
7475 }
7476
7477 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7478 // There are several ACTION_MEDIA_* broadcasts that send file://
7479 // Uris, so only check common actions.
7480 if (ACTION_VIEW.equals(mAction) ||
7481 ACTION_EDIT.equals(mAction) ||
7482 ACTION_ATTACH_DATA.equals(mAction)) {
7483 mData.checkFileUriExposed("Intent.getData()");
7484 }
7485 }
7486 }
7487
7488 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007489 * Prepare this {@link Intent} to be sent to another user
7490 *
7491 * @hide
7492 */
7493 public void prepareToLeaveUser(int userId) {
7494 Uri data = getData();
7495 if (data != null) {
7496 mData = maybeAddUserId(data, userId);
7497 }
7498 if (mSelector != null) {
7499 mSelector.prepareToLeaveUser(userId);
7500 }
7501 if (mClipData != null) {
7502 mClipData.prepareToLeaveUser(userId);
7503 }
7504 String action = getAction();
7505 if (ACTION_SEND.equals(action)) {
7506 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7507 if (stream != null) {
7508 putExtra(EXTRA_STREAM, maybeAddUserId(stream, userId));
7509 }
7510 }
7511 if (ACTION_SEND_MULTIPLE.equals(action)) {
7512 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7513 if (streams != null) {
7514 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7515 for (int i = 0; i < streams.size(); i++) {
7516 newStreams.add(maybeAddUserId(streams.get(i), userId));
7517 }
7518 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7519 }
7520 }
7521 }
7522
7523 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007524 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007525 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7526 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007527 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007528 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007529 * @hide
7530 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007531 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007532 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007533 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007534
7535 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007536 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007537
7538 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007539 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007540 try {
7541 // Inspect target intent to see if we need to migrate
7542 final Intent target = getParcelableExtra(EXTRA_INTENT);
7543 if (target != null && target.migrateExtraStreamToClipData()) {
7544 // Since we migrated in child, we need to promote ClipData
7545 // and flags to ourselves to grant.
7546 setClipData(target.getClipData());
Jeff Sharkey846318a2014-04-04 12:12:41 -07007547 addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7548 | FLAG_GRANT_WRITE_URI_PERMISSION
7549 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7550 | FLAG_GRANT_PREFIX_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007551 return true;
7552 } else {
7553 return false;
7554 }
7555 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007556 }
7557
7558 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007559 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007560 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7561 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7562 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7563 if (stream != null || text != null || htmlText != null) {
7564 final ClipData clipData = new ClipData(
7565 null, new String[] { getType() },
7566 new ClipData.Item(text, htmlText, null, stream));
7567 setClipData(clipData);
7568 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007569 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007570 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007571 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007572 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007573
7574 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007575 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007576 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7577 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7578 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7579 int num = -1;
7580 if (streams != null) {
7581 num = streams.size();
7582 }
7583 if (texts != null) {
7584 if (num >= 0 && num != texts.size()) {
7585 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007586 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007587 }
7588 num = texts.size();
7589 }
7590 if (htmlTexts != null) {
7591 if (num >= 0 && num != htmlTexts.size()) {
7592 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007593 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007594 }
7595 num = htmlTexts.size();
7596 }
7597 if (num > 0) {
7598 final ClipData clipData = new ClipData(
7599 null, new String[] { getType() },
7600 makeClipItem(streams, texts, htmlTexts, 0));
7601
7602 for (int i = 1; i < num; i++) {
7603 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7604 }
7605
7606 setClipData(clipData);
7607 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007608 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007609 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007610 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007611 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007612 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007613
7614 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007615 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007616
7617 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7618 ArrayList<String> htmlTexts, int which) {
7619 Uri uri = streams != null ? streams.get(which) : null;
7620 CharSequence text = texts != null ? texts.get(which) : null;
7621 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7622 return new ClipData.Item(text, htmlText, null, uri);
7623 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007624
7625 /** @hide */
7626 public boolean isDocument() {
7627 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7628 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007629}