blob: 586f3cd15adb79cfb09c179434e6dc25637428b5 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Adam Powell2ed547e2015-04-29 18:45:04 -070020import android.os.ResultReceiver;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010021import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070022import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070023
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import org.xmlpull.v1.XmlPullParser;
25import org.xmlpull.v1.XmlPullParserException;
26
Tor Norbye7b9c9122013-05-30 16:48:33 -070027import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070028import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070030import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070031import android.annotation.SdkConstant.SdkConstantType;
32import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070033
Nicolas Prevotd85fc722014-04-16 19:52:08 +010034import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070035
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import android.content.pm.PackageManager;
37import android.content.pm.ResolveInfo;
38import android.content.res.Resources;
39import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080040import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070041import android.net.Uri;
42import android.os.Bundle;
43import android.os.IBinder;
44import android.os.Parcel;
45import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000046import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070047import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010048import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070049import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.DocumentsProvider;
51import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070052import android.util.AttributeSet;
53import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080054
55import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070056
Craig Mautner21d24a22014-04-23 11:45:37 -070057import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070058
59import java.io.IOException;
60import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070061import java.lang.annotation.Retention;
62import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070063import java.net.URISyntaxException;
64import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070065import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080066import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070067import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070068import java.util.Set;
69
70/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
118 * VIEW action does what what is considered the most reasonable thing for
119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
189 * These strings use java style scoping, to ensure they are unique -- for
190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
342 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
361 * <p>This filter describes the ability return to the caller a note selected by
362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700541 * <li> {@link #ACTION_UID_REMOVED}
542 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700543 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700544 * <li> {@link #ACTION_POWER_DISCONNECTED}
545 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700546 * </ul>
547 *
548 * <h3>Standard Categories</h3>
549 *
550 * <p>These are the current standard categories that can be used to further
551 * clarify an Intent via {@link #addCategory}.
552 *
553 * <ul>
554 * <li> {@link #CATEGORY_DEFAULT}
555 * <li> {@link #CATEGORY_BROWSABLE}
556 * <li> {@link #CATEGORY_TAB}
557 * <li> {@link #CATEGORY_ALTERNATIVE}
558 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
559 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800560 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700561 * <li> {@link #CATEGORY_HOME}
562 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400564 * <li> {@link #CATEGORY_CAR_DOCK}
565 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500566 * <li> {@link #CATEGORY_LE_DESK_DOCK}
567 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200568 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700569 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * </ul>
571 *
572 * <h3>Standard Extra Data</h3>
573 *
574 * <p>These are the current standard fields that can be used as extra data via
575 * {@link #putExtra}.
576 *
577 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800578 * <li> {@link #EXTRA_ALARM_COUNT}
579 * <li> {@link #EXTRA_BCC}
580 * <li> {@link #EXTRA_CC}
581 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
582 * <li> {@link #EXTRA_DATA_REMOVED}
583 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500584 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
585 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_DOCK_STATE_CAR}
587 * <li> {@link #EXTRA_DOCK_STATE_DESK}
588 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
589 * <li> {@link #EXTRA_DONT_KILL_APP}
590 * <li> {@link #EXTRA_EMAIL}
591 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700592 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700594 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700596 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
598 * <li> {@link #EXTRA_REPLACING}
599 * <li> {@link #EXTRA_SHORTCUT_ICON}
600 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
601 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700602 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800603 * <li> {@link #EXTRA_SHORTCUT_NAME}
604 * <li> {@link #EXTRA_SUBJECT}
605 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800607 * <li> {@link #EXTRA_TITLE}
608 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700609 * </ul>
610 *
611 * <h3>Flags</h3>
612 *
613 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800614 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
615 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800617public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700618 private static final String ATTR_ACTION = "action";
619 private static final String TAG_CATEGORIES = "categories";
620 private static final String ATTR_CATEGORY = "category";
621 private static final String TAG_EXTRA = "extra";
622 private static final String ATTR_TYPE = "type";
623 private static final String ATTR_COMPONENT = "component";
624 private static final String ATTR_DATA = "data";
625 private static final String ATTR_FLAGS = "flags";
626
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 // ---------------------------------------------------------------------
628 // ---------------------------------------------------------------------
629 // Standard intent activity actions (see action variable).
630
631 /**
632 * Activity Action: Start as a main entry point, does not expect to
633 * receive data.
634 * <p>Input: nothing
635 * <p>Output: nothing
636 */
637 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
638 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800639
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700640 /**
641 * Activity Action: Display the data to the user. This is the most common
642 * action performed on data -- it is the generic action you can use on
643 * a piece of data to get the most reasonable thing to occur. For example,
644 * when used on a contacts entry it will view the entry; when used on a
645 * mailto: URI it will bring up a compose window filled with the information
646 * supplied by the URI; when used with a tel: URI it will invoke the
647 * dialer.
648 * <p>Input: {@link #getData} is URI from which to retrieve data.
649 * <p>Output: nothing.
650 */
651 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
652 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800653
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700654 /**
655 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
656 * performed on a piece of data.
657 */
658 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
Steve McKayc78bcb82015-07-31 14:35:22 -0700661 * Activity Action: Quick view the data.
662 * <p>Input: {@link #getData} is URI from which to retrieve data.
663 * <p>Output: nothing.
664 * @hide
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
668
669 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 * Used to indicate that some piece of data should be attached to some other
671 * place. For example, image data could be attached to a contact. It is up
672 * to the recipient to decide where the data should be attached; the intent
673 * does not specify the ultimate destination.
674 * <p>Input: {@link #getData} is URI of data to be attached.
675 * <p>Output: nothing.
676 */
677 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
678 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
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: Provide explicit editable access to the given data.
682 * <p>Input: {@link #getData} is URI of data to be edited.
683 * <p>Output: nothing.
684 */
685 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
686 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800687
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700688 /**
689 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
690 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
691 * The extras can contain type specific data to pass through to the editing/creating
692 * activity.
693 * <p>Output: The URI of the item that was picked. This must be a content:
694 * URI so that any receiver can access it.
695 */
696 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
697 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800698
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700699 /**
700 * Activity Action: Pick an item from the data, returning what was selected.
701 * <p>Input: {@link #getData} is URI containing a directory of data
702 * (vnd.android.cursor.dir/*) from which to pick an item.
703 * <p>Output: The URI of the item that was picked.
704 */
705 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
706 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700708 /**
709 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800710 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700711 * <p>Output: An Intent representing the shortcut. The intent must contain three
712 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
713 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * (value: ShortcutIconResource).</p>
715 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700716 * @see #EXTRA_SHORTCUT_INTENT
717 * @see #EXTRA_SHORTCUT_NAME
718 * @see #EXTRA_SHORTCUT_ICON
719 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
720 * @see android.content.Intent.ShortcutIconResource
721 */
722 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
723 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
724
725 /**
726 * The name of the extra used to define the Intent of a shortcut.
727 *
728 * @see #ACTION_CREATE_SHORTCUT
729 */
730 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
731 /**
732 * The name of the extra used to define the name of a shortcut.
733 *
734 * @see #ACTION_CREATE_SHORTCUT
735 */
736 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
737 /**
738 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
739 *
740 * @see #ACTION_CREATE_SHORTCUT
741 */
742 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
743 /**
744 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
745 *
746 * @see #ACTION_CREATE_SHORTCUT
747 * @see android.content.Intent.ShortcutIconResource
748 */
749 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
750 "android.intent.extra.shortcut.ICON_RESOURCE";
751
752 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800753 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700754 *
755 * @see Intent#ACTION_CREATE_SHORTCUT
756 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800757 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
758 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700759 */
760 public static class ShortcutIconResource implements Parcelable {
761 /**
762 * The package name of the application containing the icon.
763 */
764 public String packageName;
765
766 /**
767 * The resource name of the icon, including package, name and type.
768 */
769 public String resourceName;
770
771 /**
772 * Creates a new ShortcutIconResource for the specified context and resource
773 * identifier.
774 *
775 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700776 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700777 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700778 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700779 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700780 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700781 ShortcutIconResource icon = new ShortcutIconResource();
782 icon.packageName = context.getPackageName();
783 icon.resourceName = context.getResources().getResourceName(resourceId);
784 return icon;
785 }
786
787 /**
788 * Used to read a ShortcutIconResource from a Parcel.
789 */
790 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
791 new Parcelable.Creator<ShortcutIconResource>() {
792
793 public ShortcutIconResource createFromParcel(Parcel source) {
794 ShortcutIconResource icon = new ShortcutIconResource();
795 icon.packageName = source.readString();
796 icon.resourceName = source.readString();
797 return icon;
798 }
799
800 public ShortcutIconResource[] newArray(int size) {
801 return new ShortcutIconResource[size];
802 }
803 };
804
805 /**
806 * No special parcel contents.
807 */
808 public int describeContents() {
809 return 0;
810 }
811
812 public void writeToParcel(Parcel dest, int flags) {
813 dest.writeString(packageName);
814 dest.writeString(resourceName);
815 }
816
817 @Override
818 public String toString() {
819 return resourceName;
820 }
821 }
822
823 /**
824 * Activity Action: Display an activity chooser, allowing the user to pick
825 * what they want to before proceeding. This can be used as an alternative
826 * to the standard activity picker that is displayed by the system when
827 * you try to start an activity with multiple possible matches, with these
828 * differences in behavior:
829 * <ul>
830 * <li>You can specify the title that will appear in the activity chooser.
831 * <li>The user does not have the option to make one of the matching
832 * activities a preferred activity, and all possible activities will
833 * always be shown even if one of them is currently marked as the
834 * preferred activity.
835 * </ul>
836 * <p>
837 * This action should be used when the user will naturally expect to
838 * select an activity in order to proceed. An example if when not to use
839 * it is when the user clicks on a "mailto:" link. They would naturally
840 * expect to go directly to their mail app, so startActivity() should be
841 * called directly: it will
842 * either launch the current preferred app, or put up a dialog allowing the
843 * user to pick an app to use and optionally marking that as preferred.
844 * <p>
845 * In contrast, if the user is selecting a menu item to send a picture
846 * they are viewing to someone else, there are many different things they
847 * may want to do at this point: send it through e-mail, upload it to a
848 * web service, etc. In this case the CHOOSER action should be used, to
849 * always present to the user a list of the things they can do, with a
850 * nice title given by the caller such as "Send this photo with:".
851 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700852 * If you need to grant URI permissions through a chooser, you must specify
853 * the permissions to be granted on the ACTION_CHOOSER Intent
854 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
855 * {@link #setClipData} to specify the URIs to be granted as well as
856 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
857 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
858 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700859 * As a convenience, an Intent of this form can be created with the
860 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700861 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700862 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700863 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
864 * and can optionally have a {@link #EXTRA_TITLE} field containing the
865 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700866 * <p>
867 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700868 */
869 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
870 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
871
872 /**
873 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
874 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700875 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
876 * target intent, also optionally supplying a title. If the target
877 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
878 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
879 * set in the returned chooser intent, with its ClipData set appropriately:
880 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500881 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700882 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 * @param target The Intent that the user will be selecting an activity
884 * to perform.
885 * @param title Optional title that will be displayed in the chooser.
886 * @return Return a new Intent object that you can hand to
887 * {@link Context#startActivity(Intent) Context.startActivity()} and
888 * related methods.
889 */
890 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700891 return createChooser(target, title, null);
892 }
893
894 /**
895 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
896 *
897 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
898 * target intent, also optionally supplying a title. If the target
899 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
900 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
901 * set in the returned chooser intent, with its ClipData set appropriately:
902 * either a direct reflection of {@link #getClipData()} if that is non-null,
903 * or a new ClipData built from {@link #getData()}.</p>
904 *
905 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
906 * when the user makes a choice. This can be useful if the calling application wants
907 * to remember the last chosen target and surface it as a more prominent or one-touch
908 * affordance elsewhere in the UI for next time.</p>
909 *
910 * @param target The Intent that the user will be selecting an activity
911 * to perform.
912 * @param title Optional title that will be displayed in the chooser.
913 * @param sender Optional IntentSender to be called when a choice is made.
914 * @return Return a new Intent object that you can hand to
915 * {@link Context#startActivity(Intent) Context.startActivity()} and
916 * related methods.
917 */
918 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700919 Intent intent = new Intent(ACTION_CHOOSER);
920 intent.putExtra(EXTRA_INTENT, target);
921 if (title != null) {
922 intent.putExtra(EXTRA_TITLE, title);
923 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700924
Adam Powell0b3c1122014-10-09 12:50:14 -0700925 if (sender != null) {
926 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
927 }
928
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700929 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700930 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
931 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
932 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700933 if (permFlags != 0) {
934 ClipData targetClipData = target.getClipData();
935 if (targetClipData == null && target.getData() != null) {
936 ClipData.Item item = new ClipData.Item(target.getData());
937 String[] mimeTypes;
938 if (target.getType() != null) {
939 mimeTypes = new String[] { target.getType() };
940 } else {
941 mimeTypes = new String[] { };
942 }
943 targetClipData = new ClipData(null, mimeTypes, item);
944 }
945 if (targetClipData != null) {
946 intent.setClipData(targetClipData);
947 intent.addFlags(permFlags);
948 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700949 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700950
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700951 return intent;
952 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700953
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700954 /**
955 * Activity Action: Allow the user to select a particular kind of data and
956 * return it. This is different than {@link #ACTION_PICK} in that here we
957 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800958 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700959 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900960 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700961 * etc.
962 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900963 * 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 -0700964 * of data, such as a person contact, you set the MIME type to the kind of
965 * data you want and launch it with {@link Context#startActivity(Intent)}.
966 * The system will then launch the best application to select that kind
967 * of data for you.
968 * <p>
969 * You may also be interested in any of a set of types of content the user
970 * can pick. For example, an e-mail application that wants to allow the
971 * user to add an attachment to an e-mail message can use this action to
972 * bring up a list of all of the types of content the user can attach.
973 * <p>
974 * In this case, you should wrap the GET_CONTENT intent with a chooser
975 * (through {@link #createChooser}), which will give the proper interface
976 * for the user to pick how to send your data and allow you to specify
977 * a prompt indicating what they are doing. You will usually specify a
978 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
979 * broad range of content types the user can select from.
980 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900981 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700982 * only pick from data that can be represented as a stream. This is
983 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
984 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800985 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900986 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800987 * is locally available on the device. For example, if this extra is set
988 * to true then an image picker should not show any pictures that are available
989 * from a remote server but not already on the local device (thus requiring
990 * they be downloaded when opened).
991 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800992 * If the caller can handle multiple returned items (the user performing
993 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
994 * to indicate this.
995 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700996 * Input: {@link #getType} is the desired MIME type to retrieve. Note
997 * that no URI is supplied in the intent, as there are no constraints on
998 * where the returned data originally comes from. You may also include the
999 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001000 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001001 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1002 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001003 * <p>
1004 * Output: The URI of the item that was picked. This must be a content:
1005 * URI so that any receiver can access it.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1009 /**
1010 * Activity Action: Dial a number as specified by the data. This shows a
1011 * UI with the number being dialed, allowing the user to explicitly
1012 * initiate the call.
1013 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1014 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1015 * number.
1016 * <p>Output: nothing.
1017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1020 /**
1021 * Activity Action: Perform a call to someone specified by the data.
1022 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1023 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1024 * number.
1025 * <p>Output: nothing.
1026 *
1027 * <p>Note: there will be restrictions on which applications can initiate a
1028 * call; most applications should use the {@link #ACTION_DIAL}.
1029 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1030 * numbers. Applications can <strong>dial</strong> emergency numbers using
1031 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001032 *
1033 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#MNC MNC}
1034 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001035 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001036 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001037 */
1038 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1039 public static final String ACTION_CALL = "android.intent.action.CALL";
1040 /**
1041 * Activity Action: Perform a call to an emergency number specified by the
1042 * data.
1043 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1044 * tel: URI of an explicit phone number.
1045 * <p>Output: nothing.
1046 * @hide
1047 */
1048 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1049 /**
1050 * Activity action: Perform a call to any number (emergency or not)
1051 * specified by the data.
1052 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1053 * tel: URI of an explicit phone number.
1054 * <p>Output: nothing.
1055 * @hide
1056 */
1057 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1058 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001059 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1060 * sending this intent is a no-op.
1061 * <p>Input: No data should be specified. get*Extra may have an optional
1062 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1063 * send the activation result.
1064 * <p>Output: nothing.
1065 * @hide
1066 */
1067 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1068 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1069 "android.intent.action.SIM_ACTIVATION_REQUEST";
1070 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001071 * Activity Action: Send a message to someone specified by the data.
1072 * <p>Input: {@link #getData} is URI describing the target.
1073 * <p>Output: nothing.
1074 */
1075 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1076 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1077 /**
1078 * Activity Action: Deliver some data to someone else. Who the data is
1079 * being delivered to is not specified; it is up to the receiver of this
1080 * action to ask the user where the data should be sent.
1081 * <p>
1082 * When launching a SEND intent, you should usually wrap it in a chooser
1083 * (through {@link #createChooser}), which will give the proper interface
1084 * for the user to pick how to send your data and allow you to specify
1085 * a prompt indicating what they are doing.
1086 * <p>
1087 * Input: {@link #getType} is the MIME type of the data being sent.
1088 * get*Extra can have either a {@link #EXTRA_TEXT}
1089 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1090 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1091 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1092 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001093 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1094 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1095 * your text with HTML formatting.
1096 * <p>
1097 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1098 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1099 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1100 * content: URIs and other advanced features of {@link ClipData}. If
1101 * using this approach, you still must supply the same data through the
1102 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1103 * for compatibility with old applications. If you don't set a ClipData,
1104 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001105 * <p>
1106 * Optional standard extras, which may be interpreted by some recipients as
1107 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1108 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1109 * <p>
1110 * Output: nothing.
1111 */
1112 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1113 public static final String ACTION_SEND = "android.intent.action.SEND";
1114 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001115 * Activity Action: Deliver multiple data to someone else.
1116 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001117 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001118 * <p>
1119 * Input: {@link #getType} is the MIME type of the data being sent.
1120 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001121 * #EXTRA_STREAM} field, containing the data to be sent. If using
1122 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1123 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001124 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001125 * Multiple types are supported, and receivers should handle mixed types
1126 * whenever possible. The right way for the receiver to check them is to
1127 * use the content resolver on each URI. The intent sender should try to
1128 * put the most concrete mime type in the intent type, but it can fall
1129 * back to {@literal <type>/*} or {@literal *}/* as needed.
1130 * <p>
1131 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1132 * be image/jpg, but if you are sending image/jpg and image/png, then the
1133 * intent's type should be image/*.
1134 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001135 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1136 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1137 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1138 * content: URIs and other advanced features of {@link ClipData}. If
1139 * using this approach, you still must supply the same data through the
1140 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1141 * for compatibility with old applications. If you don't set a ClipData,
1142 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1143 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001144 * Optional standard extras, which may be interpreted by some recipients as
1145 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1146 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1147 * <p>
1148 * Output: nothing.
1149 */
1150 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1151 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1152 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001153 * Activity Action: Handle an incoming phone call.
1154 * <p>Input: nothing.
1155 * <p>Output: nothing.
1156 */
1157 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1158 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1159 /**
1160 * Activity Action: Insert an empty item into the given container.
1161 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1162 * in which to place the data.
1163 * <p>Output: URI of the new data that was created.
1164 */
1165 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1166 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1167 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001168 * Activity Action: Create a new item in the given container, initializing it
1169 * from the current contents of the clipboard.
1170 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1171 * in which to place the data.
1172 * <p>Output: URI of the new data that was created.
1173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1176 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001177 * Activity Action: Delete the given data from its container.
1178 * <p>Input: {@link #getData} is URI of data to be deleted.
1179 * <p>Output: nothing.
1180 */
1181 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1182 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1183 /**
1184 * Activity Action: Run the data, whatever that means.
1185 * <p>Input: ? (Note: this is currently specific to the test harness.)
1186 * <p>Output: nothing.
1187 */
1188 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1189 public static final String ACTION_RUN = "android.intent.action.RUN";
1190 /**
1191 * Activity Action: Perform a data synchronization.
1192 * <p>Input: ?
1193 * <p>Output: ?
1194 */
1195 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1196 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1197 /**
1198 * Activity Action: Pick an activity given an intent, returning the class
1199 * selected.
1200 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1201 * used with {@link PackageManager#queryIntentActivities} to determine the
1202 * set of activities from which to pick.
1203 * <p>Output: Class name of the activity that was selected.
1204 */
1205 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1206 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1207 /**
1208 * Activity Action: Perform a search.
1209 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1210 * is the text to search for. If empty, simply
1211 * enter your search results Activity with the search UI activated.
1212 * <p>Output: nothing.
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1216 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001217 * Activity Action: Start the platform-defined tutorial
1218 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1219 * is the text to search for. If empty, simply
1220 * enter your search results Activity with the search UI activated.
1221 * <p>Output: nothing.
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1225 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001226 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001227 * <p>
1228 * Input: {@link android.app.SearchManager#QUERY
1229 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1230 * a url starts with http or https, the site will be opened. If it is plain
1231 * text, Google search will be applied.
1232 * <p>
1233 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001237
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001238 /**
Jim Miller07994402012-05-02 14:22:27 -07001239 * Activity Action: Perform assist action.
1240 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001241 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1242 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001243 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1244 * information.
Jim Miller07994402012-05-02 14:22:27 -07001245 * Output: nothing.
1246 */
1247 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1248 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001249
1250 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001251 * Activity Action: Perform voice assist action.
1252 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001253 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1254 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001255 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001256 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001257 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001258 */
1259 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1260 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1261
1262 /**
Adam Skory7140a252013-09-11 12:04:58 +01001263 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1264 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001265 */
1266 public static final String EXTRA_ASSIST_PACKAGE
1267 = "android.intent.extra.ASSIST_PACKAGE";
1268
1269 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001270 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1271 * application package at the time the assist was invoked.
1272 */
1273 public static final String EXTRA_ASSIST_UID
1274 = "android.intent.extra.ASSIST_UID";
1275
1276 /**
Adam Skory7140a252013-09-11 12:04:58 +01001277 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1278 * information supplied by the current foreground app at the time of the assist request.
1279 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001280 */
1281 public static final String EXTRA_ASSIST_CONTEXT
1282 = "android.intent.extra.ASSIST_CONTEXT";
1283
Jim Miller07994402012-05-02 14:22:27 -07001284 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001285 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1286 * keyboard as the primary input device for assistance.
1287 */
1288 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1289 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1290
1291 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001292 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1293 * that was used to invoke the assist.
1294 */
1295 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1296 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1297
1298 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001299 * Activity Action: List all available applications
1300 * <p>Input: Nothing.
1301 * <p>Output: nothing.
1302 */
1303 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1304 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1305 /**
1306 * Activity Action: Show settings for choosing wallpaper
1307 * <p>Input: Nothing.
1308 * <p>Output: Nothing.
1309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1312
1313 /**
1314 * Activity Action: Show activity for reporting a bug.
1315 * <p>Input: Nothing.
1316 * <p>Output: Nothing.
1317 */
1318 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1319 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1320
1321 /**
1322 * Activity Action: Main entry point for factory tests. Only used when
1323 * the device is booting in factory test node. The implementing package
1324 * must be installed in the system image.
1325 * <p>Input: nothing
1326 * <p>Output: nothing
1327 */
1328 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1329
1330 /**
1331 * Activity Action: The user pressed the "call" button to go to the dialer
1332 * or other appropriate UI for placing a call.
1333 * <p>Input: Nothing.
1334 * <p>Output: Nothing.
1335 */
1336 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1337 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1338
1339 /**
1340 * Activity Action: Start Voice Command.
1341 * <p>Input: Nothing.
1342 * <p>Output: Nothing.
1343 */
1344 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1345 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001346
1347 /**
1348 * Activity Action: Start action associated with long pressing on the
1349 * search key.
1350 * <p>Input: Nothing.
1351 * <p>Output: Nothing.
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001355
Jacek Surazski86b6c532009-05-13 14:38:28 +02001356 /**
1357 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1358 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001359 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001360 * <p>Input: No data is specified. The bug report is passed in using
1361 * an {@link #EXTRA_BUG_REPORT} field.
1362 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001363 *
1364 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001365 */
1366 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1367 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001368
1369 /**
1370 * Activity Action: Show power usage information to the user.
1371 * <p>Input: Nothing.
1372 * <p>Output: Nothing.
1373 */
1374 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1375 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001376
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001377 /**
1378 * Activity Action: Setup wizard to launch after a platform update. This
1379 * activity should have a string meta-data field associated with it,
1380 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1381 * the platform for setup. The activity will be launched only if
1382 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1383 * same value.
1384 * <p>Input: Nothing.
1385 * <p>Output: Nothing.
1386 * @hide
1387 */
1388 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1389 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001390
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001391 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001392 * Activity Action: Show settings for managing network data usage of a
1393 * specific application. Applications should define an activity that offers
1394 * options to control data usage.
1395 */
1396 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1397 public static final String ACTION_MANAGE_NETWORK_USAGE =
1398 "android.intent.action.MANAGE_NETWORK_USAGE";
1399
1400 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001401 * Activity Action: Launch application installer.
1402 * <p>
1403 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001404 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1405 * you can also use "package:<package-name>" to install an application for the
1406 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001407 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1408 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1409 * <p>
1410 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1411 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001412 * <p>
1413 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1414 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1415 * in order to launch the application installer.
1416 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001417 *
1418 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1419 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1420 * @see #EXTRA_RETURN_RESULT
1421 */
1422 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1423 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1424
1425 /**
1426 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1427 * package. Specifies the installer package name; this package will receive the
1428 * {@link #ACTION_APP_ERROR} intent.
1429 */
1430 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1431 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1432
1433 /**
1434 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1435 * package. Specifies that the application being installed should not be
1436 * treated as coming from an unknown source, but as coming from the app
1437 * invoking the Intent. For this to work you must start the installer with
1438 * startActivityForResult().
1439 */
1440 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1441 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1442
1443 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001444 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1445 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001446 * data field originated from.
1447 */
rich cannings706e8ba2012-08-20 13:20:14 -07001448 public static final String EXTRA_ORIGINATING_URI
1449 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001450
1451 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001452 * This extra can be used with any Intent used to launch an activity, supplying information
1453 * about who is launching that activity. This field contains a {@link android.net.Uri}
1454 * object, typically an http: or https: URI of the web site that the referral came from;
1455 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1456 * a native application that it came from.
1457 *
1458 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1459 * instead of directly retrieving the extra. It is also valid for applications to
1460 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1461 * a string, not a Uri; the field here, if supplied, will always take precedence,
1462 * however.</p>
1463 *
1464 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001465 */
1466 public static final String EXTRA_REFERRER
1467 = "android.intent.extra.REFERRER";
1468
1469 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001470 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1471 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1472 * not be created, in particular when Intent extras are supplied through the
1473 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1474 * schemes.
1475 *
1476 * @see #EXTRA_REFERRER
1477 */
1478 public static final String EXTRA_REFERRER_NAME
1479 = "android.intent.extra.REFERRER_NAME";
1480
1481 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001482 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1483 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1484 * @hide
1485 */
1486 public static final String EXTRA_ORIGINATING_UID
1487 = "android.intent.extra.ORIGINATING_UID";
1488
1489 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001490 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1491 * package. Tells the installer UI to skip the confirmation with the user
1492 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001493 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1494 * will no longer show an interstitial message about updating existing
1495 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001496 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001497 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001498 public static final String EXTRA_ALLOW_REPLACE
1499 = "android.intent.extra.ALLOW_REPLACE";
1500
1501 /**
1502 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1503 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1504 * return to the application the result code of the install/uninstall. The returned result
1505 * code will be {@link android.app.Activity#RESULT_OK} on success or
1506 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1507 */
1508 public static final String EXTRA_RETURN_RESULT
1509 = "android.intent.extra.RETURN_RESULT";
1510
1511 /**
1512 * Package manager install result code. @hide because result codes are not
1513 * yet ready to be exposed.
1514 */
1515 public static final String EXTRA_INSTALL_RESULT
1516 = "android.intent.extra.INSTALL_RESULT";
1517
1518 /**
1519 * Activity Action: Launch application uninstaller.
1520 * <p>
1521 * Input: The data must be a package: URI whose scheme specific part is
1522 * the package name of the current installed package to be uninstalled.
1523 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1524 * <p>
1525 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1526 * succeeded.
1527 */
1528 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1529 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1530
1531 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001532 * Specify whether the package should be uninstalled for all users.
1533 * @hide because these should not be part of normal application flow.
1534 */
1535 public static final String EXTRA_UNINSTALL_ALL_USERS
1536 = "android.intent.extra.UNINSTALL_ALL_USERS";
1537
1538 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001539 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1540 * describing the last run version of the platform that was setup.
1541 * @hide
1542 */
1543 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1544
Svet Ganov3695b8a2015-03-24 16:30:25 -07001545 /**
1546 * Activity action: Launch UI to manage the permissions of an app.
1547 * <p>
1548 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1549 * will be managed by the launched UI.
1550 * </p>
1551 * <p>
1552 * Output: Nothing.
1553 * </p>
1554 *
1555 * @see #EXTRA_PACKAGE_NAME
1556 *
1557 * @hide
1558 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001559 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1560 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1561 "android.intent.action.MANAGE_APP_PERMISSIONS";
1562
1563 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001564 * Activity action: Launch UI to manage permissions.
1565 * <p>
1566 * Input: Nothing.
1567 * </p>
1568 * <p>
1569 * Output: Nothing.
1570 * </p>
1571 *
1572 * @hide
1573 */
Svet Ganov321f0152015-05-16 22:51:50 -07001574 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1575 public static final String ACTION_MANAGE_PERMISSIONS =
1576 "android.intent.action.MANAGE_PERMISSIONS";
1577
1578 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001579 * Intent extra: An app package name.
1580 * <p>
1581 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001582 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001583 *
1584 * @hide
1585 */
1586 @SystemApi
1587 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1588
1589 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001590 * Broadcast action that requests current permission granted information. It will respond
1591 * to the request by sending a broadcast with action defined by
1592 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001593 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1594 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1595 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001596 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001597 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1598 * number of permissions requested and the number of granted additional permissions
1599 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001600 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001601 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1602 * of localized permission group names that are granted in
1603 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001604 *
1605 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1606 * permissions and the total number of apps requesting runtime permissions will be the first
1607 * and second elements respectively of an int[] in the response as
1608 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1609 *
1610 * @hide
1611 */
1612 public static final String ACTION_GET_PERMISSIONS_COUNT
1613 = "android.intent.action.GET_PERMISSIONS_COUNT";
1614
1615 /**
1616 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1617 * @hide
1618 */
1619 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1620 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1621
1622 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001623 * List of CharSequence of localized permission group labels.
1624 * @hide
1625 */
1626 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1627 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1628
1629 /**
1630 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001631 * @hide
1632 */
1633 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1634 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1635
1636 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001637 * Activity action: Launch UI to manage which apps have a given permission.
1638 * <p>
1639 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1640 * to which will be managed by the launched UI.
1641 * </p>
1642 * <p>
1643 * Output: Nothing.
1644 * </p>
1645 *
1646 * @see #EXTRA_PERMISSION_NAME
1647 *
1648 * @hide
1649 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001650 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1651 public static final String ACTION_MANAGE_PERMISSION_APPS =
1652 "android.intent.action.MANAGE_PERMISSION_APPS";
1653
1654 /**
1655 * Intent extra: The name of a permission.
1656 * <p>
1657 * Type: String
1658 * </p>
1659 *
1660 * @hide
1661 */
1662 @SystemApi
1663 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1664
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001665 // ---------------------------------------------------------------------
1666 // ---------------------------------------------------------------------
1667 // Standard intent broadcast actions (see action variable).
1668
1669 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001670 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1671 * <p>
1672 * For historical reasons, the name of this broadcast action refers to the power
1673 * state of the screen but it is actually sent in response to changes in the
1674 * overall interactive state of the device.
1675 * </p><p>
1676 * This broadcast is sent when the device becomes non-interactive which may have
1677 * nothing to do with the screen turning off. To determine the
1678 * actual state of the screen, use {@link android.view.Display#getState}.
1679 * </p><p>
1680 * See {@link android.os.PowerManager#isInteractive} for details.
1681 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001682 * You <em>cannot</em> receive this through components declared in
1683 * manifests, only by explicitly registering for it with
1684 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1685 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001686 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001687 * <p class="note">This is a protected intent that can only be sent
1688 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001689 */
1690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1691 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001692
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001693 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001694 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1695 * <p>
1696 * For historical reasons, the name of this broadcast action refers to the power
1697 * state of the screen but it is actually sent in response to changes in the
1698 * overall interactive state of the device.
1699 * </p><p>
1700 * This broadcast is sent when the device becomes interactive which may have
1701 * nothing to do with the screen turning on. To determine the
1702 * actual state of the screen, use {@link android.view.Display#getState}.
1703 * </p><p>
1704 * See {@link android.os.PowerManager#isInteractive} for details.
1705 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001706 * You <em>cannot</em> receive this through components declared in
1707 * manifests, only by explicitly registering for it with
1708 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1709 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001710 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001711 * <p class="note">This is a protected intent that can only be sent
1712 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001713 */
1714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1715 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001716
1717 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001718 * Broadcast Action: Sent after the system stops dreaming.
1719 *
1720 * <p class="note">This is a protected intent that can only be sent by the system.
1721 * It is only sent to registered receivers.</p>
1722 */
1723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1724 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1725
1726 /**
1727 * Broadcast Action: Sent after the system starts dreaming.
1728 *
1729 * <p class="note">This is a protected intent that can only be sent by the system.
1730 * It is only sent to registered receivers.</p>
1731 */
1732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1733 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1734
1735 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001736 * 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 -07001737 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001738 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001739 * <p class="note">This is a protected intent that can only be sent
1740 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001741 */
1742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001743 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001744
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001745 /**
1746 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001747 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001748 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001749 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1750 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001751 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001752 * <p class="note">This is a protected intent that can only be sent
1753 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001754 */
1755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1756 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1757 /**
1758 * Broadcast Action: The time was set.
1759 */
1760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1761 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1762 /**
1763 * Broadcast Action: The date has changed.
1764 */
1765 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1766 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1767 /**
1768 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1769 * <ul>
1770 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1771 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001772 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001773 * <p class="note">This is a protected intent that can only be sent
1774 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001775 */
1776 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1777 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1778 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001779 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1780 * DNS entries should be tossed.
1781 * @hide
1782 */
1783 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1784 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1785 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001786 * Alarm Changed Action: This is broadcast when the AlarmClock
1787 * application's alarm is set or unset. It is used by the
1788 * AlarmClock application and the StatusBar service.
1789 * @hide
1790 */
1791 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1792 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1793 /**
1794 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1795 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1796 * @hide
1797 */
1798 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1799 public static final String ACTION_SYNC_STATE_CHANGED
1800 = "android.intent.action.SYNC_STATE_CHANGED";
1801 /**
1802 * Broadcast Action: This is broadcast once, after the system has finished
1803 * booting. It can be used to perform application-specific initialization,
1804 * such as installing alarms. You must hold the
1805 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1806 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001807 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001808 * <p class="note">This is a protected intent that can only be sent
1809 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001810 */
1811 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1812 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1813 /**
1814 * Broadcast Action: This is broadcast when a user action should request a
1815 * temporary system dialog to dismiss. Some examples of temporary system
1816 * dialogs are the notification window-shade and the recent tasks dialog.
1817 */
1818 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1819 /**
1820 * Broadcast Action: Trigger the download and eventual installation
1821 * of a package.
1822 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001823 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001824 * <p class="note">This is a protected intent that can only be sent
1825 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001826 *
1827 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001828 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001829 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001830 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1831 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1832 /**
1833 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001834 * device. The data contains the name of the package. Note that the
1835 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001836 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001837 * <ul>
1838 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1839 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1840 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1841 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1848 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001849 * Broadcast Action: A new version of an application package has been
1850 * installed, replacing an existing version that was previously installed.
1851 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001852 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001853 * <ul>
1854 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1855 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001856 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001857 * <p class="note">This is a protected intent that can only be sent
1858 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001859 */
1860 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1861 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1862 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001863 * Broadcast Action: A new version of your application has been installed
1864 * over an existing one. This is only sent to the application that was
1865 * replaced. It does not contain any additional data; to receive it, just
1866 * use an intent filter for this action.
1867 *
1868 * <p class="note">This is a protected intent that can only be sent
1869 * by the system.
1870 */
1871 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1872 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1873 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001874 * Broadcast Action: An existing application package has been removed from
1875 * the device. The data contains the name of the package. The package
1876 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001877 * <ul>
1878 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1879 * to the package.
1880 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1881 * application -- data and code -- is being removed.
1882 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1883 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1884 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001885 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001886 * <p class="note">This is a protected intent that can only be sent
1887 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001888 */
1889 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1890 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1891 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001892 * Broadcast Action: An existing application package has been completely
1893 * removed from the device. The data contains the name of the package.
1894 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1895 * {@link #EXTRA_DATA_REMOVED} is true and
1896 * {@link #EXTRA_REPLACING} is false of that broadcast.
1897 *
1898 * <ul>
1899 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1900 * to the package.
1901 * </ul>
1902 *
1903 * <p class="note">This is a protected intent that can only be sent
1904 * by the system.
1905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1907 public static final String ACTION_PACKAGE_FULLY_REMOVED
1908 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1909 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001910 * Broadcast Action: An existing application package has been changed (e.g.
1911 * a component has been enabled or disabled). The data contains the name of
1912 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001913 * <ul>
1914 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001915 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001916 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001917 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1918 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001919 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001920 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001921 * <p class="note">This is a protected intent that can only be sent
1922 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923 */
1924 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1925 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1926 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001927 * @hide
1928 * Broadcast Action: Ask system services if there is any reason to
1929 * restart the given package. The data contains the name of the
1930 * package.
1931 * <ul>
1932 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1933 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1934 * </ul>
1935 *
1936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
1938 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08001939 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001940 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1941 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1942 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001943 * Broadcast Action: The user has restarted a package, and all of its
1944 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001945 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001946 * be removed. Note that the restarted package does <em>not</em>
1947 * receive this broadcast.
1948 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001949 * <ul>
1950 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1951 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001952 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001953 * <p class="note">This is a protected intent that can only be sent
1954 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 */
1956 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1957 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1958 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001959 * Broadcast Action: The user has cleared the data of a package. This should
1960 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001961 * its persistent data is erased and this broadcast sent.
1962 * Note that the cleared package does <em>not</em>
1963 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001964 * <ul>
1965 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1966 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001967 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001968 * <p class="note">This is a protected intent that can only be sent
1969 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001970 */
1971 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1972 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1973 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 * Broadcast Action: A user ID has been removed from the system. The user
1975 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001976 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001977 * <p class="note">This is a protected intent that can only be sent
1978 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 */
1980 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1981 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001982
1983 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001984 * Broadcast Action: Sent to the installer package of an application
1985 * when that application is first launched (that is the first time it
1986 * is moved out of the stopped state). The data contains the name of the package.
1987 *
1988 * <p class="note">This is a protected intent that can only be sent
1989 * by the system.
1990 */
1991 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1992 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1993
1994 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001995 * Broadcast Action: Sent to the system package verifier when a package
1996 * needs to be verified. The data contains the package URI.
1997 * <p class="note">
1998 * This is a protected intent that can only be sent by the system.
1999 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002000 */
2001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2002 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2003
2004 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002005 * Broadcast Action: Sent to the system package verifier when a package is
2006 * verified. The data contains the package URI.
2007 * <p class="note">
2008 * This is a protected intent that can only be sent by the system.
2009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2012
2013 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002014 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2015 * needs to be verified. The data contains the filter data hosts to be verified against.
2016 * <p class="note">
2017 * This is a protected intent that can only be sent by the system.
2018 * </p>
2019 *
2020 * @hide
2021 */
2022 @SystemApi
2023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2025
2026 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002027 * Broadcast Action: Resources for a set of packages (which were
2028 * previously unavailable) are currently
2029 * available since the media on which they exist is available.
2030 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2031 * list of packages whose availability changed.
2032 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2033 * list of uids of packages whose availability changed.
2034 * Note that the
2035 * packages in this list do <em>not</em> receive this broadcast.
2036 * The specified set of packages are now available on the system.
2037 * <p>Includes the following extras:
2038 * <ul>
2039 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2040 * whose resources(were previously unavailable) are currently available.
2041 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2042 * packages whose resources(were previously unavailable)
2043 * are currently available.
2044 * </ul>
2045 *
2046 * <p class="note">This is a protected intent that can only be sent
2047 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002048 */
2049 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002050 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2051 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002052
2053 /**
2054 * Broadcast Action: Resources for a set of packages are currently
2055 * unavailable since the media on which they exist is unavailable.
2056 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2057 * list of packages whose availability changed.
2058 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2059 * list of uids of packages whose availability changed.
2060 * The specified set of packages can no longer be
2061 * launched and are practically unavailable on the system.
2062 * <p>Inclues the following extras:
2063 * <ul>
2064 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2065 * whose resources are no longer available.
2066 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2067 * whose resources are no longer available.
2068 * </ul>
2069 *
2070 * <p class="note">This is a protected intent that can only be sent
2071 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002072 */
2073 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002074 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002075 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002076
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002077 /**
2078 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002079 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002080 * This should <em>only</em> be used to determine when the wallpaper
2081 * has changed to show the new wallpaper to the user. You should certainly
2082 * never, in response to this, change the wallpaper or other attributes of
2083 * it such as the suggested size. That would be crazy, right? You'd cause
2084 * all kinds of loops, especially if other apps are doing similar things,
2085 * right? Of course. So please don't do this.
2086 *
2087 * @deprecated Modern applications should use
2088 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2089 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2090 * shown behind their UI, rather than watching for this broadcast and
2091 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002092 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002093 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002094 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2095 /**
2096 * Broadcast Action: The current device {@link android.content.res.Configuration}
2097 * (orientation, locale, etc) has changed. When such a change happens, the
2098 * UIs (view hierarchy) will need to be rebuilt based on this new
2099 * information; for the most part, applications don't need to worry about
2100 * this, because the system will take care of stopping and restarting the
2101 * application to make sure it sees the new changes. Some system code that
2102 * can not be restarted will need to watch for this action and handle it
2103 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002104 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002105 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002106 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002107 * in manifests, only by explicitly registering for it with
2108 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2109 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002110 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002111 * <p class="note">This is a protected intent that can only be sent
2112 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002113 *
2114 * @see android.content.res.Configuration
2115 */
2116 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2117 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2118 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002119 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002120 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002121 * <p class="note">This is a protected intent that can only be sent
2122 * by the system.
2123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2126 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002127 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2128 * charging state, level, and other information about the battery.
2129 * See {@link android.os.BatteryManager} for documentation on the
2130 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002131 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002133 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002134 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002135 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002136 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2137 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2138 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2139 * broadcasts that are sent and can be received through manifest
2140 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002141 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002142 * <p class="note">This is a protected intent that can only be sent
2143 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002144 */
2145 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2146 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2147 /**
2148 * Broadcast Action: Indicates low battery condition on the device.
2149 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002150 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002151 * <p class="note">This is a protected intent that can only be sent
2152 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2156 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002157 * Broadcast Action: Indicates the battery is now okay after being low.
2158 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2159 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002160 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002161 * <p class="note">This is a protected intent that can only be sent
2162 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002163 */
2164 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2165 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2166 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002167 * Broadcast Action: External power has been connected to the device.
2168 * This is intended for applications that wish to register specifically to this notification.
2169 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2170 * stay active to receive this notification. This action can be used to implement actions
2171 * that wait until power is available to trigger.
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.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002175 */
2176 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002177 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002178 /**
2179 * Broadcast Action: External power has been removed from the device.
2180 * This is intended for applications that wish to register specifically to this notification.
2181 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2182 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002183 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002184 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002185 * <p class="note">This is a protected intent that can only be sent
2186 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002189 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002190 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002191 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002192 * Broadcast Action: Device is shutting down.
2193 * This is broadcast when the device is being shut down (completely turned
2194 * off, not sleeping). Once the broadcast is complete, the final shutdown
2195 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002196 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002197 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002198 * <p class="note">This is a protected intent that can only be sent
2199 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002200 * <p>May include the following extras:
2201 * <ul>
2202 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2203 * shutdown is only for userspace processes. If not set, assumed to be false.
2204 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002205 */
2206 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002207 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002208 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002209 * Activity Action: Start this activity to request system shutdown.
2210 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
2211 * to request confirmation from the user before shutting down.
2212 *
2213 * <p class="note">This is a protected intent that can only be sent
2214 * by the system.
2215 *
2216 * {@hide}
2217 */
2218 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2219 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002220 * Broadcast Action: A sticky broadcast that indicates low memory
2221 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002222 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002223 * <p class="note">This is a protected intent that can only be sent
2224 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002225 */
2226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2227 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2228 /**
2229 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002230 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002231 * <p class="note">This is a protected intent that can only be sent
2232 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2236 /**
Jake Hambybb371632010-08-23 18:16:48 -07002237 * Broadcast Action: A sticky broadcast that indicates a memory full
2238 * condition on the device. This is intended for activities that want
2239 * to be able to fill the data partition completely, leaving only
2240 * enough free space to prevent system-wide SQLite failures.
2241 *
2242 * <p class="note">This is a protected intent that can only be sent
2243 * by the system.
2244 *
2245 * {@hide}
2246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2248 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2249 /**
2250 * Broadcast Action: Indicates memory full condition on the device
2251 * no longer exists.
2252 *
2253 * <p class="note">This is a protected intent that can only be sent
2254 * by the system.
2255 *
2256 * {@hide}
2257 */
2258 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2259 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2260 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002261 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2262 * and package management should be started.
2263 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2264 * notification.
2265 */
2266 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2267 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2268 /**
2269 * Broadcast Action: The device has entered USB Mass Storage mode.
2270 * This is used mainly for the USB Settings panel.
2271 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2272 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002273 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002274 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002275 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002276 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2277
2278 /**
2279 * Broadcast Action: The device has exited USB Mass Storage mode.
2280 * This is used mainly for the USB Settings panel.
2281 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2282 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002283 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002284 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002285 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002286 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2287
2288 /**
2289 * Broadcast Action: External media has been removed.
2290 * The path to the mount point for the removed media is contained in the Intent.mData field.
2291 */
2292 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2293 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2294
2295 /**
2296 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002297 * 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 -07002298 */
2299 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2300 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2301
2302 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002303 * Broadcast Action: External media is present, and being disk-checked
2304 * 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 -08002305 */
2306 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2307 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2308
2309 /**
2310 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2311 * 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 -08002312 */
2313 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2314 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2315
2316 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002317 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002318 * 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 -07002319 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2320 * media was mounted read only.
2321 */
2322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2323 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2324
2325 /**
2326 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002327 * 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 -07002328 */
2329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2330 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2331
2332 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002333 * Broadcast Action: External media is no longer being shared via USB mass storage.
2334 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2335 *
2336 * @hide
2337 */
2338 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2339
2340 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002341 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2342 * The path to the mount point for the removed media is contained in the Intent.mData field.
2343 */
2344 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2345 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2346
2347 /**
2348 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002349 * 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 -07002350 */
2351 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2352 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2353
2354 /**
2355 * Broadcast Action: User has expressed the desire to remove the external storage media.
2356 * Applications should close all files they have open within the mount point when they receive this intent.
2357 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2358 */
2359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2360 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2361
2362 /**
2363 * Broadcast Action: The media scanner has started scanning a directory.
2364 * The path to the directory being scanned is contained in the Intent.mData field.
2365 */
2366 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2367 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2368
2369 /**
2370 * Broadcast Action: The media scanner has finished scanning a directory.
2371 * The path to the scanned directory is contained in the Intent.mData field.
2372 */
2373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2374 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2375
2376 /**
2377 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2378 * The path to the file is contained in the Intent.mData field.
2379 */
2380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2381 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2382
2383 /**
2384 * Broadcast Action: The "Media Button" was pressed. Includes a single
2385 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2386 * caused the broadcast.
2387 */
2388 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2389 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2390
2391 /**
2392 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2393 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2394 * caused the broadcast.
2395 */
2396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2397 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2398
2399 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2400 // location; they are not general-purpose actions.
2401
2402 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002403 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002404 */
2405 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2406 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2407 "android.intent.action.GTALK_CONNECTED";
2408
2409 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002410 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002411 */
2412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2413 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2414 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002415
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002416 /**
2417 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002418 */
2419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2420 public static final String ACTION_INPUT_METHOD_CHANGED =
2421 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002422
2423 /**
2424 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2425 * more radios have been turned off or on. The intent will have the following extra value:</p>
2426 * <ul>
2427 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2428 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2429 * turned off</li>
2430 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002431 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002432 * <p class="note">This is a protected intent that can only be sent
2433 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002434 */
2435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2436 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2437
2438 /**
2439 * Broadcast Action: Some content providers have parts of their namespace
2440 * where they publish new events or items that the user may be especially
2441 * interested in. For these things, they may broadcast this action when the
2442 * set of interesting items change.
2443 *
2444 * For example, GmailProvider sends this notification when the set of unread
2445 * mail in the inbox changes.
2446 *
2447 * <p>The data of the intent identifies which part of which provider
2448 * changed. When queried through the content resolver, the data URI will
2449 * return the data set in question.
2450 *
2451 * <p>The intent will have the following extra values:
2452 * <ul>
2453 * <li><em>count</em> - The number of items in the data set. This is the
2454 * same as the number of items in the cursor returned by querying the
2455 * data URI. </li>
2456 * </ul>
2457 *
2458 * This intent will be sent at boot (if the count is non-zero) and when the
2459 * data set changes. It is possible for the data set to change without the
2460 * count changing (for example, if a new unread message arrives in the same
2461 * sync operation in which a message is archived). The phone should still
2462 * ring/vibrate/etc as normal in this case.
2463 */
2464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2465 public static final String ACTION_PROVIDER_CHANGED =
2466 "android.intent.action.PROVIDER_CHANGED";
2467
2468 /**
2469 * Broadcast Action: Wired Headset plugged in or unplugged.
2470 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002471 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2472 * and documentation.
2473 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002474 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002475 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002476 */
2477 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002478 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002479
2480 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002481 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2482 * <ul>
2483 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2484 * </ul>
2485 *
2486 * <p class="note">This is a protected intent that can only be sent
2487 * by the system.
2488 *
2489 * @hide
2490 */
2491 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2492 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2493 = "android.intent.action.ADVANCED_SETTINGS";
2494
2495 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002496 * Broadcast Action: Sent after application restrictions are changed.
2497 *
2498 * <p class="note">This is a protected intent that can only be sent
2499 * by the system.</p>
2500 */
2501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2502 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2503 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2504
2505 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002506 * Broadcast Action: An outgoing call is about to be placed.
2507 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002508 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002509 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002510 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002511 * the phone number originally intended to be dialed.</li>
2512 * </ul>
2513 * <p>Once the broadcast is finished, the resultData is used as the actual
2514 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002515 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002516 * outgoing call in turn: for example, a parental control application
2517 * might verify that the user is authorized to place the call at that
2518 * time, then a number-rewriting application might add an area code if
2519 * one was not specified.</p>
2520 * <p>For consistency, any receiver whose purpose is to prohibit phone
2521 * calls should have a priority of 0, to ensure it will see the final
2522 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002523 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002524 * should have a positive priority.
2525 * Negative priorities are reserved for the system for this broadcast;
2526 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002527 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2528 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002529 * <p>Emergency calls cannot be intercepted using this mechanism, and
2530 * other calls cannot be modified to call emergency numbers using this
2531 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002532 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2533 * call to use their own service instead. Those apps should first prevent
2534 * the call from being placed by setting resultData to <code>null</code>
2535 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002536 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002537 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2538 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002539 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002540 * <p class="note">This is a protected intent that can only be sent
2541 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002542 */
2543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2544 public static final String ACTION_NEW_OUTGOING_CALL =
2545 "android.intent.action.NEW_OUTGOING_CALL";
2546
2547 /**
2548 * Broadcast Action: Have the device reboot. This is only for use by
2549 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002550 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002551 * <p class="note">This is a protected intent that can only be sent
2552 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002553 */
2554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2555 public static final String ACTION_REBOOT =
2556 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002557
Wei Huang97ecc9c2009-05-11 17:44:20 -07002558 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002559 * Broadcast Action: A sticky broadcast for changes in the physical
2560 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002561 *
2562 * <p>The intent will have the following extra values:
2563 * <ul>
2564 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002565 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002566 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002567 * <p>This is intended for monitoring the current physical dock state.
2568 * See {@link android.app.UiModeManager} for the normal API dealing with
2569 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002570 */
2571 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2572 public static final String ACTION_DOCK_EVENT =
2573 "android.intent.action.DOCK_EVENT";
2574
2575 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002576 * Broadcast Action: A broadcast when idle maintenance can be started.
2577 * This means that the user is not interacting with the device and is
2578 * not expected to do so soon. Typical use of the idle maintenance is
2579 * to perform somehow expensive tasks that can be postponed at a moment
2580 * when they will not degrade user experience.
2581 * <p>
2582 * <p class="note">In order to keep the device responsive in case of an
2583 * unexpected user interaction, implementations of a maintenance task
2584 * should be interruptible. In such a scenario a broadcast with action
2585 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2586 * should not do the maintenance work in
2587 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2588 * maintenance service by {@link Context#startService(Intent)}. Also
2589 * you should hold a wake lock while your maintenance service is running
2590 * to prevent the device going to sleep.
2591 * </p>
2592 * <p>
2593 * <p class="note">This is a protected intent that can only be sent by
2594 * the system.
2595 * </p>
2596 *
2597 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002598 *
2599 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2602 public static final String ACTION_IDLE_MAINTENANCE_START =
2603 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2604
2605 /**
2606 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2607 * This means that the user was not interacting with the device as a result
2608 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2609 * was sent and now the user started interacting with the device. Typical
2610 * use of the idle maintenance is to perform somehow expensive tasks that
2611 * can be postponed at a moment when they will not degrade user experience.
2612 * <p>
2613 * <p class="note">In order to keep the device responsive in case of an
2614 * unexpected user interaction, implementations of a maintenance task
2615 * should be interruptible. Hence, on receiving a broadcast with this
2616 * action, the maintenance task should be interrupted as soon as possible.
2617 * In other words, you should not do the maintenance work in
2618 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2619 * maintenance service that was started on receiving of
2620 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2621 * lock you acquired when your maintenance service started.
2622 * </p>
2623 * <p class="note">This is a protected intent that can only be sent
2624 * by the system.
2625 *
2626 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002627 *
2628 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002629 */
2630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2631 public static final String ACTION_IDLE_MAINTENANCE_END =
2632 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2633
2634 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002635 * Broadcast Action: a remote intent is to be broadcasted.
2636 *
2637 * A remote intent is used for remote RPC between devices. The remote intent
2638 * is serialized and sent from one device to another device. The receiving
2639 * device parses the remote intent and broadcasts it. Note that anyone can
2640 * broadcast a remote intent. However, if the intent receiver of the remote intent
2641 * does not trust intent broadcasts from arbitrary intent senders, it should require
2642 * the sender to hold certain permissions so only trusted sender's broadcast will be
2643 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002644 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002645 */
2646 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002647 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002648
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002649 /**
2650 * Broadcast Action: hook for permforming cleanup after a system update.
2651 *
2652 * The broadcast is sent when the system is booting, before the
2653 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2654 * image. A receiver for this should do its work and then disable itself
2655 * so that it does not get run again at the next boot.
2656 * @hide
2657 */
2658 public static final String ACTION_PRE_BOOT_COMPLETED =
2659 "android.intent.action.PRE_BOOT_COMPLETED";
2660
Amith Yamasani13593602012-03-22 16:16:17 -07002661 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002662 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002663 * on restricted users. The broadcast intent contains an extra
2664 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2665 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2666 * String[] depending on the restriction type.<p/>
2667 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002668 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2669 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2670 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002671 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2672 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002673 * @see RestrictionEntry
2674 */
2675 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2676 "android.intent.action.GET_RESTRICTION_ENTRIES";
2677
2678 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002679 * Sent the first time a user is starting, to allow system apps to
2680 * perform one time initialization. (This will not be seen by third
2681 * party applications because a newly initialized user does not have any
2682 * third party applications installed for it.) This is sent early in
2683 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002684 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2685 * broadcast, since it is part of a visible user interaction; be as quick
2686 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002687 */
2688 public static final String ACTION_USER_INITIALIZE =
2689 "android.intent.action.USER_INITIALIZE";
2690
2691 /**
2692 * Sent when a user switch is happening, causing the process's user to be
2693 * brought to the foreground. This is only sent to receivers registered
2694 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2695 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002696 * foreground. This is sent as a foreground
2697 * broadcast, since it is part of a visible user interaction; be as quick
2698 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002699 */
2700 public static final String ACTION_USER_FOREGROUND =
2701 "android.intent.action.USER_FOREGROUND";
2702
2703 /**
2704 * Sent when a user switch is happening, causing the process's user to be
2705 * sent to the background. This is only sent to receivers registered
2706 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2707 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002708 * background. This is sent as a foreground
2709 * broadcast, since it is part of a visible user interaction; be as quick
2710 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002711 */
2712 public static final String ACTION_USER_BACKGROUND =
2713 "android.intent.action.USER_BACKGROUND";
2714
2715 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002716 * Broadcast sent to the system when a user is added. Carries an extra
2717 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2718 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002719 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002720 * @hide
2721 */
2722 public static final String ACTION_USER_ADDED =
2723 "android.intent.action.USER_ADDED";
2724
2725 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002726 * Broadcast sent by the system when a user is started. Carries an extra
2727 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002728 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002729 * that has been started. This is sent as a foreground
2730 * broadcast, since it is part of a visible user interaction; be as quick
2731 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002732 * @hide
2733 */
2734 public static final String ACTION_USER_STARTED =
2735 "android.intent.action.USER_STARTED";
2736
2737 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002738 * Broadcast sent when a user is in the process of starting. Carries an extra
2739 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2740 * sent to registered receivers, not manifest receivers. It is sent to all
2741 * users (including the one that is being started). You must hold
2742 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2743 * this broadcast. This is sent as a background broadcast, since
2744 * its result is not part of the primary UX flow; to safely keep track of
2745 * started/stopped state of a user you can use this in conjunction with
2746 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2747 * other user state broadcasts since those are foreground broadcasts so can
2748 * execute in a different order.
2749 * @hide
2750 */
2751 public static final String ACTION_USER_STARTING =
2752 "android.intent.action.USER_STARTING";
2753
2754 /**
2755 * Broadcast sent when a user is going to be stopped. Carries an extra
2756 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2757 * sent to registered receivers, not manifest receivers. It is sent to all
2758 * users (including the one that is being stopped). You must hold
2759 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2760 * this broadcast. The user will not stop until all receivers have
2761 * handled the broadcast. This is sent as a background broadcast, since
2762 * its result is not part of the primary UX flow; to safely keep track of
2763 * started/stopped state of a user you can use this in conjunction with
2764 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2765 * other user state broadcasts since those are foreground broadcasts so can
2766 * execute in a different order.
2767 * @hide
2768 */
2769 public static final String ACTION_USER_STOPPING =
2770 "android.intent.action.USER_STOPPING";
2771
2772 /**
2773 * Broadcast sent to the system when a user is stopped. Carries an extra
2774 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2775 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2776 * specific package. This is only sent to registered receivers, not manifest
2777 * receivers. It is sent to all running users <em>except</em> the one that
2778 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002779 * @hide
2780 */
2781 public static final String ACTION_USER_STOPPED =
2782 "android.intent.action.USER_STOPPED";
2783
2784 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002785 * 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 -07002786 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002787 * one that has been removed. The user will not be completely removed until all receivers have
2788 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002789 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002790 * @hide
2791 */
2792 public static final String ACTION_USER_REMOVED =
2793 "android.intent.action.USER_REMOVED";
2794
2795 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002796 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002797 * the userHandle of the user to become the current one. This is only sent to
2798 * registered receivers, not manifest receivers. It is sent to all running users.
2799 * You must hold
2800 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002801 * @hide
2802 */
2803 public static final String ACTION_USER_SWITCHED =
2804 "android.intent.action.USER_SWITCHED";
2805
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002806 /**
2807 * Broadcast sent to the system when a user's information changes. Carries an extra
2808 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002809 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002810 * @hide
2811 */
2812 public static final String ACTION_USER_INFO_CHANGED =
2813 "android.intent.action.USER_INFO_CHANGED";
2814
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002815 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002816 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2817 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002818 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2819 * that need to display merged content across both primary and managed profiles need to
2820 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002821 * not manifest receivers.
2822 */
2823 public static final String ACTION_MANAGED_PROFILE_ADDED =
2824 "android.intent.action.MANAGED_PROFILE_ADDED";
2825
2826 /**
2827 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002828 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2829 * Only applications (for example Launchers) that need to display merged content across both
2830 * primary and managed profiles need to worry about this broadcast. This is only sent to
2831 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002832 */
2833 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2834 "android.intent.action.MANAGED_PROFILE_REMOVED";
2835
2836 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002837 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2838 */
2839 public static final String ACTION_QUICK_CLOCK =
2840 "android.intent.action.QUICK_CLOCK";
2841
Michael Wright0087a142013-02-05 16:29:39 -08002842 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002843 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002844 * @hide
2845 */
2846 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2847 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2848
Justin Kohd378ad72013-04-01 12:18:26 -07002849 /**
2850 * Broadcast Action: A global button was pressed. Includes a single
2851 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2852 * caused the broadcast.
2853 * @hide
2854 */
2855 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2856
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002857 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002858 * Activity Action: Allow the user to select and return one or more existing
2859 * documents. When invoked, the system will display the various
2860 * {@link DocumentsProvider} instances installed on the device, letting the
2861 * user interactively navigate through them. These documents include local
2862 * media, such as photos and video, and documents provided by installed
2863 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002864 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002865 * Each document is represented as a {@code content://} URI backed by a
2866 * {@link DocumentsProvider}, which can be opened as a stream with
2867 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2868 * {@link android.provider.DocumentsContract.Document} metadata.
2869 * <p>
2870 * All selected documents are returned to the calling application with
2871 * persistable read and write permission grants. If you want to maintain
2872 * access to the documents across device reboots, you need to explicitly
2873 * take the persistable permissions using
2874 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2875 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002876 * Callers must indicate the acceptable document MIME types through
2877 * {@link #setType(String)}. For example, to select photos, use
2878 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2879 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2880 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002881 * <p>
2882 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002883 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2884 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002885 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002886 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2887 * returned URIs can be opened with
2888 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002889 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002890 * Output: The URI of the item that was picked, returned in
2891 * {@link #getData()}. This must be a {@code content://} URI so that any
2892 * receiver can access it. If multiple documents were selected, they are
2893 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002894 *
2895 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002896 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002897 * @see #ACTION_CREATE_DOCUMENT
2898 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002899 */
2900 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2901 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2902
2903 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002904 * Activity Action: Allow the user to create a new document. When invoked,
2905 * the system will display the various {@link DocumentsProvider} instances
2906 * installed on the device, letting the user navigate through them. The
2907 * returned document may be a newly created document with no content, or it
2908 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002909 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002910 * Each document is represented as a {@code content://} URI backed by a
2911 * {@link DocumentsProvider}, which can be opened as a stream with
2912 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2913 * {@link android.provider.DocumentsContract.Document} metadata.
2914 * <p>
2915 * Callers must indicate the concrete MIME type of the document being
2916 * created by setting {@link #setType(String)}. This MIME type cannot be
2917 * changed after the document is created.
2918 * <p>
2919 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2920 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002921 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002922 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2923 * returned URIs can be opened with
2924 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002925 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002926 * Output: The URI of the item that was created. This must be a
2927 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002928 *
2929 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002930 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002931 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002932 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002933 */
2934 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2935 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2936
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002937 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002938 * Activity Action: Allow the user to pick a directory subtree. When
2939 * invoked, the system will display the various {@link DocumentsProvider}
2940 * instances installed on the device, letting the user navigate through
2941 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002942 * <p>
2943 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002944 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2945 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2946 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002947 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002948 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002949 *
2950 * @see DocumentsContract
2951 */
2952 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002953 public static final String
2954 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002955
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002956 /** {@hide} */
2957 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2958
Christopher Tate6597e342015-02-17 12:15:25 -08002959 /**
2960 * Broadcast action: report that a settings element is being restored from backup. The intent
2961 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
2962 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
2963 * is the value of that settings entry prior to the restore operation. All of these values are
2964 * represented as strings.
2965 *
2966 * <p>This broadcast is sent only for settings provider entries known to require special handling
2967 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
2968 * the provider's backup agent implementation.
2969 *
2970 * @see #EXTRA_SETTING_NAME
2971 * @see #EXTRA_SETTING_PREVIOUS_VALUE
2972 * @see #EXTRA_SETTING_NEW_VALUE
2973 * {@hide}
2974 */
2975 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
2976
2977 /** {@hide} */
2978 public static final String EXTRA_SETTING_NAME = "setting_name";
2979 /** {@hide} */
2980 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
2981 /** {@hide} */
2982 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
2983
Clara Bayarri0a26157a2015-03-26 18:38:55 +00002984 /**
2985 * Activity Action: Process a piece of text.
2986 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
2987 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
2988 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
2989 */
2990 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2991 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
2992 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01002993 * The name of the extra used to define the text to be processed, as a
2994 * CharSequence. Note that this may be a styled CharSequence, so you must use
2995 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00002996 */
2997 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
2998 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01002999 * The name of the boolean extra used to define if the processed text will be used as read-only.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003000 */
3001 public static final String EXTRA_PROCESS_TEXT_READONLY =
3002 "android.intent.extra.PROCESS_TEXT_READONLY";
3003
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003004 // ---------------------------------------------------------------------
3005 // ---------------------------------------------------------------------
3006 // Standard intent categories (see addCategory()).
3007
3008 /**
3009 * Set if the activity should be an option for the default action
3010 * (center press) to perform on a piece of data. Setting this will
3011 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003012 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003013 * Intent when initiating an action -- it is for use in intent filters
3014 * specified in packages.
3015 */
3016 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3017 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3018 /**
3019 * Activities that can be safely invoked from a browser must support this
3020 * category. For example, if the user is viewing a web page or an e-mail
3021 * and clicks on a link in the text, the Intent generated execute that
3022 * link will require the BROWSABLE category, so that only activities
3023 * supporting this category will be considered as possible actions. By
3024 * supporting this category, you are promising that there is nothing
3025 * damaging (without user intervention) that can happen by invoking any
3026 * matching Intent.
3027 */
3028 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3029 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3030 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003031 * Categories for activities that can participate in voice interaction.
3032 * An activity that supports this category must be prepared to run with
3033 * no UI shown at all (though in some case it may have a UI shown), and
3034 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3035 */
3036 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3037 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3038 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003039 * Set if the activity should be considered as an alternative action to
3040 * the data the user is currently viewing. See also
3041 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3042 * applies to the selection in a list of items.
3043 *
3044 * <p>Supporting this category means that you would like your activity to be
3045 * displayed in the set of alternative things the user can do, usually as
3046 * part of the current activity's options menu. You will usually want to
3047 * include a specific label in the &lt;intent-filter&gt; of this action
3048 * describing to the user what it does.
3049 *
3050 * <p>The action of IntentFilter with this category is important in that it
3051 * describes the specific action the target will perform. This generally
3052 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3053 * a specific name such as "com.android.camera.action.CROP. Only one
3054 * alternative of any particular action will be shown to the user, so using
3055 * a specific action like this makes sure that your alternative will be
3056 * displayed while also allowing other applications to provide their own
3057 * overrides of that particular action.
3058 */
3059 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3060 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3061 /**
3062 * Set if the activity should be considered as an alternative selection
3063 * action to the data the user has currently selected. This is like
3064 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3065 * of items from which the user can select, giving them alternatives to the
3066 * default action that will be performed on it.
3067 */
3068 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3069 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3070 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003071 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003072 */
3073 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3074 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3075 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003076 * Should be displayed in the top-level launcher.
3077 */
3078 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3079 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3080 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003081 * Indicates an activity optimized for Leanback mode, and that should
3082 * be displayed in the Leanback launcher.
3083 */
3084 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3085 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3086 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003087 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3088 * @hide
3089 */
3090 @SystemApi
3091 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3092 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003093 * Provides information about the package it is in; typically used if
3094 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3095 * a front-door to the user without having to be shown in the all apps list.
3096 */
3097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3098 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3099 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003100 * This is the home activity, that is the first activity that is displayed
3101 * when the device boots.
3102 */
3103 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3104 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3105 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003106 * This is the setup wizard activity, that is the first activity that is displayed
3107 * when the user sets up the device for the first time.
3108 * @hide
3109 */
3110 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3111 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3112 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003113 * This activity is a preference panel.
3114 */
3115 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3116 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3117 /**
3118 * This activity is a development preference panel.
3119 */
3120 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3121 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3122 /**
3123 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003124 */
3125 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3126 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3127 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003128 * This activity allows the user to browse and download new applications.
3129 */
3130 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3131 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3132 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003133 * This activity may be exercised by the monkey or other automated test tools.
3134 */
3135 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3136 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3137 /**
3138 * To be used as a test (not part of the normal user experience).
3139 */
3140 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3141 /**
3142 * To be used as a unit test (run through the Test Harness).
3143 */
3144 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3145 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003146 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003147 * experience).
3148 */
3149 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003150
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003151 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003152 * Used to indicate that an intent only wants URIs that can be opened with
3153 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3154 * must support at least the columns defined in {@link OpenableColumns} when
3155 * queried.
3156 *
3157 * @see #ACTION_GET_CONTENT
3158 * @see #ACTION_OPEN_DOCUMENT
3159 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003160 */
3161 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3162 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3163
3164 /**
3165 * To be used as code under test for framework instrumentation tests.
3166 */
3167 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3168 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003169 /**
3170 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003171 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3172 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003173 */
3174 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3175 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3176 /**
3177 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003178 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3179 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003180 */
3181 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3182 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003183 /**
3184 * An activity to run when device is inserted into a analog (low end) dock.
3185 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3186 * information, see {@link android.app.UiModeManager}.
3187 */
3188 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3189 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3190
3191 /**
3192 * An activity to run when device is inserted into a digital (high end) dock.
3193 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3194 * information, see {@link android.app.UiModeManager}.
3195 */
3196 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3197 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003198
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003199 /**
3200 * Used to indicate that the activity can be used in a car environment.
3201 */
3202 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3203 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3204
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003205 // ---------------------------------------------------------------------
3206 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003207 // Application launch intent categories (see addCategory()).
3208
3209 /**
3210 * Used with {@link #ACTION_MAIN} to launch the browser application.
3211 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003212 * <p>NOTE: This should not be used as the primary key of an Intent,
3213 * since it will not result in the app launching with the correct
3214 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003215 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003216 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003217 */
3218 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3219 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3220
3221 /**
3222 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3223 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003224 * <p>NOTE: This should not be used as the primary key of an Intent,
3225 * since it will not result in the app launching with the correct
3226 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003227 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003228 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003229 */
3230 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3231 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3232
3233 /**
3234 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3235 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003236 * <p>NOTE: This should not be used as the primary key of an Intent,
3237 * since it will not result in the app launching with the correct
3238 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003239 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003240 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003241 */
3242 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3243 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3244
3245 /**
3246 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3247 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003248 * <p>NOTE: This should not be used as the primary key of an Intent,
3249 * since it will not result in the app launching with the correct
3250 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003251 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003252 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003253 */
3254 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3255 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3256
3257 /**
3258 * Used with {@link #ACTION_MAIN} to launch the email application.
3259 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003260 * <p>NOTE: This should not be used as the primary key of an Intent,
3261 * since it will not result in the app launching with the correct
3262 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003263 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003264 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003265 */
3266 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3267 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3268
3269 /**
3270 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3271 * The activity should be able to view and manipulate image and video files
3272 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003273 * <p>NOTE: This should not be used as the primary key of an Intent,
3274 * since it will not result in the app launching with the correct
3275 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003276 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003277 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003278 */
3279 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3280 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3281
3282 /**
3283 * Used with {@link #ACTION_MAIN} to launch the maps application.
3284 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003285 * <p>NOTE: This should not be used as the primary key of an Intent,
3286 * since it will not result in the app launching with the correct
3287 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003288 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003289 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003290 */
3291 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3292 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3293
3294 /**
3295 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3296 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003297 * <p>NOTE: This should not be used as the primary key of an Intent,
3298 * since it will not result in the app launching with the correct
3299 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003300 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003301 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003302 */
3303 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3304 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3305
3306 /**
3307 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003308 * The activity should be able to play, browse, or manipulate music files
3309 * stored on the device.
3310 * <p>NOTE: This should not be used as the primary key of an Intent,
3311 * since it will not result in the app launching with the correct
3312 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003313 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003314 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003315 */
3316 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3317 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3318
3319 // ---------------------------------------------------------------------
3320 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003321 // Standard extra data keys.
3322
3323 /**
3324 * The initial data to place in a newly created record. Use with
3325 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3326 * fields as would be given to the underlying ContentProvider.insert()
3327 * call.
3328 */
3329 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3330
3331 /**
3332 * A constant CharSequence that is associated with the Intent, used with
3333 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3334 * this may be a styled CharSequence, so you must use
3335 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3336 * retrieve it.
3337 */
3338 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3339
3340 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003341 * A constant String that is associated with the Intent, used with
3342 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3343 * as HTML formatted text. Note that you <em>must</em> also supply
3344 * {@link #EXTRA_TEXT}.
3345 */
3346 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3347
3348 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003349 * A content: URI holding a stream of data associated with the Intent,
3350 * used with {@link #ACTION_SEND} to supply the data being sent.
3351 */
3352 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3353
3354 /**
3355 * A String[] holding e-mail addresses that should be delivered to.
3356 */
3357 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3358
3359 /**
3360 * A String[] holding e-mail addresses that should be carbon copied.
3361 */
3362 public static final String EXTRA_CC = "android.intent.extra.CC";
3363
3364 /**
3365 * A String[] holding e-mail addresses that should be blind carbon copied.
3366 */
3367 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3368
3369 /**
3370 * A constant string holding the desired subject line of a message.
3371 */
3372 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3373
3374 /**
3375 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003376 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003377 */
3378 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3379
3380 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003381 * An Intent[] describing additional, alternate choices you would like shown with
3382 * {@link #ACTION_CHOOSER}.
3383 *
3384 * <p>An app may be capable of providing several different payload types to complete a
3385 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3386 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3387 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3388 * photo data or a hosted link where the photos can be viewed.</p>
3389 *
3390 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3391 * first/primary/preferred intent in the set. Additional intents specified in
3392 * this extra are ordered; by default intents that appear earlier in the array will be
3393 * preferred over intents that appear later in the array as matches for the same
3394 * target component. To alter this preference, a calling app may also supply
3395 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3396 */
3397 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3398
3399 /**
3400 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3401 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3402 *
3403 * <p>An app preparing an action for another app to complete may wish to allow the user to
3404 * disambiguate between several options for completing the action based on the chosen target
3405 * or otherwise refine the action before it is invoked.
3406 * </p>
3407 *
3408 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3409 * <ul>
3410 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3411 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3412 * chosen target beyond the first</li>
3413 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3414 * should fill in and send once the disambiguation is complete</li>
3415 * </ul>
3416 */
3417 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3418 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3419
3420 /**
3421 * A {@link ResultReceiver} used to return data back to the sender.
3422 *
3423 * <p>Used to complete an app-specific
3424 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3425 *
3426 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3427 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3428 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3429 * when the user selects a target component from the chooser. It is up to the recipient
3430 * to send a result to this ResultReceiver to signal that disambiguation is complete
3431 * and that the chooser should invoke the user's choice.</p>
3432 *
3433 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3434 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3435 * to match and fill in the final Intent or ChooserTarget before starting it.
3436 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3437 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3438 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3439 *
3440 * <p>The result code passed to the ResultReceiver should be
3441 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3442 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3443 * the chooser should finish without starting a target.</p>
3444 */
3445 public static final String EXTRA_RESULT_RECEIVER
3446 = "android.intent.extra.RESULT_RECEIVER";
3447
3448 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003449 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003450 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003451 */
3452 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3453
3454 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003455 * A Parcelable[] of {@link Intent} or
3456 * {@link android.content.pm.LabeledIntent} objects as set with
3457 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3458 * a the front of the list of choices, when shown to the user with a
3459 * {@link #ACTION_CHOOSER}.
3460 */
3461 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3462
3463 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003464 * A Bundle forming a mapping of potential target package names to different extras Bundles
3465 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3466 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3467 * be currently installed on the device.
3468 *
3469 * <p>An application may choose to provide alternate extras for the case where a user
3470 * selects an activity from a predetermined set of target packages. If the activity
3471 * the user selects from the chooser belongs to a package with its package name as
3472 * a key in this bundle, the corresponding extras for that package will be merged with
3473 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3474 * extra has the same key as an extra already present in the intent it will overwrite
3475 * the extra from the intent.</p>
3476 *
3477 * <p><em>Examples:</em>
3478 * <ul>
3479 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3480 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3481 * parameters for that target.</li>
3482 * <li>An application may offer additional metadata for known targets of a given intent
3483 * to pass along information only relevant to that target such as account or content
3484 * identifiers already known to that application.</li>
3485 * </ul></p>
3486 */
3487 public static final String EXTRA_REPLACEMENT_EXTRAS =
3488 "android.intent.extra.REPLACEMENT_EXTRAS";
3489
3490 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003491 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3492 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3493 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3494 * {@link ComponentName} of the chosen component.
3495 *
3496 * <p>In some situations this callback may never come, for example if the user abandons
3497 * the chooser, switches to another task or any number of other reasons. Apps should not
3498 * be written assuming that this callback will always occur.</p>
3499 */
3500 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3501 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3502
3503 /**
3504 * The {@link ComponentName} chosen by the user to complete an action.
3505 *
3506 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3507 */
3508 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3509
3510 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003511 * A {@link android.view.KeyEvent} object containing the event that
3512 * triggered the creation of the Intent it is in.
3513 */
3514 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3515
3516 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003517 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3518 * before shutting down.
3519 *
3520 * {@hide}
3521 */
3522 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3523
3524 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003525 * 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 -07003526 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3527 * of restarting the application.
3528 */
3529 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3530
3531 /**
3532 * A String holding the phone number originally entered in
3533 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3534 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3535 */
3536 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003537
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003538 /**
3539 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3540 * intents to supply the uid the package had been assigned. Also an optional
3541 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3542 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3543 * purpose.
3544 */
3545 public static final String EXTRA_UID = "android.intent.extra.UID";
3546
3547 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003548 * @hide String array of package names.
3549 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003550 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003551 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3552
3553 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003554 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3555 * intents to indicate whether this represents a full uninstall (removing
3556 * both the code and its data) or a partial uninstall (leaving its data,
3557 * implying that this is an update).
3558 */
3559 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003560
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003561 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003562 * @hide
3563 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3564 * intents to indicate that at this point the package has been removed for
3565 * all users on the device.
3566 */
3567 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3568 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3569
3570 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003571 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3572 * intents to indicate that this is a replacement of the package, so this
3573 * broadcast will immediately be followed by an add broadcast for a
3574 * different version of the same package.
3575 */
3576 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003577
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003578 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003579 * Used as an int extra field in {@link android.app.AlarmManager} intents
3580 * to tell the application being invoked how many pending alarms are being
3581 * delievered with the intent. For one-shot alarms this will always be 1.
3582 * For recurring alarms, this might be greater than 1 if the device was
3583 * asleep or powered off at the time an earlier alarm would have been
3584 * delivered.
3585 */
3586 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003587
Jacek Surazski86b6c532009-05-13 14:38:28 +02003588 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003589 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3590 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003591 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3592 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003593 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3594 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3595 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003596 */
3597 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3598
3599 /**
3600 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3601 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003602 */
3603 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3604
3605 /**
3606 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3607 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003608 */
3609 public static final int EXTRA_DOCK_STATE_DESK = 1;
3610
3611 /**
3612 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3613 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003614 */
3615 public static final int EXTRA_DOCK_STATE_CAR = 2;
3616
3617 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003618 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3619 * to represent that the phone is in a analog (low end) dock.
3620 */
3621 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3622
3623 /**
3624 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3625 * to represent that the phone is in a digital (high end) dock.
3626 */
3627 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3628
3629 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003630 * Boolean that can be supplied as meta-data with a dock activity, to
3631 * indicate that the dock should take over the home key when it is active.
3632 */
3633 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003634
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003635 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003636 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3637 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003638 */
3639 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3640
3641 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003642 * Used in the extra field in the remote intent. It's astring token passed with the
3643 * remote intent.
3644 */
3645 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3646 "android.intent.extra.remote_intent_token";
3647
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003648 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003649 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003650 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003651 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003652 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003653 "android.intent.extra.changed_component_name";
3654
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003655 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003656 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003657 * and contains a string array of all of the components that have changed. If
3658 * the state of the overall package has changed, then it will contain an entry
3659 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003660 */
3661 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3662 "android.intent.extra.changed_component_name_list";
3663
3664 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003665 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003666 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3667 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003668 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003669 */
3670 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3671 "android.intent.extra.changed_package_list";
3672
3673 /**
3674 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003675 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3676 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003677 * and contains an integer array of uids of all of the components
3678 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003679 */
3680 public static final String EXTRA_CHANGED_UID_LIST =
3681 "android.intent.extra.changed_uid_list";
3682
3683 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003684 * @hide
3685 * Magic extra system code can use when binding, to give a label for
3686 * who it is that has bound to a service. This is an integer giving
3687 * a framework string resource that can be displayed to the user.
3688 */
3689 public static final String EXTRA_CLIENT_LABEL =
3690 "android.intent.extra.client_label";
3691
3692 /**
3693 * @hide
3694 * Magic extra system code can use when binding, to give a PendingIntent object
3695 * that can be launched for the user to disable the system's use of this
3696 * service.
3697 */
3698 public static final String EXTRA_CLIENT_INTENT =
3699 "android.intent.extra.client_intent";
3700
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003701 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003702 * Extra used to indicate that an intent should only return data that is on
3703 * the local device. This is a boolean extra; the default is false. If true,
3704 * an implementation should only allow the user to select data that is
3705 * already on the device, not requiring it be downloaded from a remote
3706 * service when opened.
3707 *
3708 * @see #ACTION_GET_CONTENT
3709 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003710 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003711 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003712 */
3713 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003714 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003715
Amith Yamasani13593602012-03-22 16:16:17 -07003716 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003717 * Extra used to indicate that an intent can allow the user to select and
3718 * return multiple items. This is a boolean extra; the default is false. If
3719 * true, an implementation is allowed to present the user with a UI where
3720 * they can pick multiple items that are all returned to the caller. When
3721 * this happens, they should be returned as the {@link #getClipData()} part
3722 * of the result Intent.
3723 *
3724 * @see #ACTION_GET_CONTENT
3725 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003726 */
3727 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003728 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003729
3730 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003731 * The integer userHandle carried with broadcast intents related to addition, removal and
3732 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3733 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3734 *
Amith Yamasani13593602012-03-22 16:16:17 -07003735 * @hide
3736 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003737 public static final String EXTRA_USER_HANDLE =
3738 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003739
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003740 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003741 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3742 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3743 */
3744 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003745 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003746
3747 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003748 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003749 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3750 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003751 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003752 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3753
3754 /**
3755 * Extra sent in the intent to the BroadcastReceiver that handles
3756 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3757 * the restrictions as key/value pairs.
3758 */
3759 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3760 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003761
Amith Yamasani86118ba2013-03-28 14:33:16 -07003762 /**
3763 * Extra used in the response from a BroadcastReceiver that handles
3764 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3765 */
3766 public static final String EXTRA_RESTRICTIONS_INTENT =
3767 "android.intent.extra.restrictions_intent";
3768
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003769 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003770 * Extra used to communicate a set of acceptable MIME types. The type of the
3771 * extra is {@code String[]}. Values may be a combination of concrete MIME
3772 * types (such as "image/png") and/or partial MIME types (such as
3773 * "audio/*").
3774 *
3775 * @see #ACTION_GET_CONTENT
3776 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003777 */
3778 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3779
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003780 /**
3781 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3782 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003783 * When this is true, hardware devices can use this information to determine that
3784 * they shouldn't do a complete shutdown of their device since this is not a
3785 * complete shutdown down to the kernel, but only user space restarting.
3786 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003787 */
3788 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3789 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3790
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003791 /**
3792 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3793 * user has set their time format preferences to the 24 hour format.
3794 *
3795 * @hide for internal use only.
3796 */
3797 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3798 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3799
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003800 /** {@hide} */
3801 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3802
Rubin Xue8490f12015-06-25 12:17:48 +01003803 /** {@hide} */
3804 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
3805
Santos Cordon15a13782015-03-31 18:32:31 -07003806 /**
3807 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
3808 * activation request.
3809 * TODO: Add information about the structure and response data used with the pending intent.
3810 * @hide
3811 */
3812 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
3813 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
3814
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003815 // ---------------------------------------------------------------------
3816 // ---------------------------------------------------------------------
3817 // Intent flags (see mFlags variable).
3818
Tor Norbyed9273d62013-05-30 15:59:53 -07003819 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003820 @IntDef(flag = true, value = {
3821 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3822 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003823 @Retention(RetentionPolicy.SOURCE)
3824 public @interface GrantUriMode {}
3825
Jeff Sharkey846318a2014-04-04 12:12:41 -07003826 /** @hide */
3827 @IntDef(flag = true, value = {
3828 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3829 @Retention(RetentionPolicy.SOURCE)
3830 public @interface AccessUriMode {}
3831
3832 /**
3833 * Test if given mode flags specify an access mode, which must be at least
3834 * read and/or write.
3835 *
3836 * @hide
3837 */
3838 public static boolean isAccessUriMode(int modeFlags) {
3839 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3840 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3841 }
3842
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003843 /**
3844 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003845 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003846 * specified in its ClipData. When applying to an Intent's ClipData,
3847 * all URIs as well as recursive traversals through data or other ClipData
3848 * in Intent items will be granted; only the grant flags of the top-level
3849 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003850 */
3851 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3852 /**
3853 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003854 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003855 * specified in its ClipData. When applying to an Intent's ClipData,
3856 * all URIs as well as recursive traversals through data or other ClipData
3857 * in Intent items will be granted; only the grant flags of the top-level
3858 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003859 */
3860 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3861 /**
3862 * Can be set by the caller to indicate that this Intent is coming from
3863 * a background operation, not from direct user interaction.
3864 */
3865 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3866 /**
3867 * A flag you can enable for debugging: when set, log messages will be
3868 * printed during the resolution of this intent to show you what has
3869 * been found to create the final resolved list.
3870 */
3871 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003872 /**
3873 * If set, this intent will not match any components in packages that
3874 * are currently stopped. If this is not set, then the default behavior
3875 * is to include such applications in the result.
3876 */
3877 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3878 /**
3879 * If set, this intent will always match any components in packages that
3880 * are currently stopped. This is the default behavior when
3881 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3882 * flags are set, this one wins (it allows overriding of exclude for
3883 * places where the framework may automatically set the exclude flag).
3884 */
3885 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003886
3887 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003888 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003889 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003890 * persisted across device reboots until explicitly revoked with
3891 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3892 * grant for possible persisting; the receiving application must call
3893 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3894 * actually persist.
3895 *
3896 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3897 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3898 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003899 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003900 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003901 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003902
3903 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003904 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3905 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3906 * applies to any URI that is a prefix match against the original granted
3907 * URI. (Without this flag, the URI must match exactly for access to be
3908 * granted.) Another URI is considered a prefix match only when scheme,
3909 * authority, and all path segments defined by the prefix are an exact
3910 * match.
3911 */
3912 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3913
3914 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003915 * If set, the new activity is not kept in the history stack. As soon as
3916 * the user navigates away from it, the activity is finished. This may also
3917 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3918 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07003919 *
3920 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
3921 * is never invoked when the current activity starts a new activity which
3922 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003923 */
3924 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3925 /**
3926 * If set, the activity will not be launched if it is already running
3927 * at the top of the history stack.
3928 */
3929 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3930 /**
3931 * If set, this activity will become the start of a new task on this
3932 * history stack. A task (from the activity that started it to the
3933 * next task activity) defines an atomic group of activities that the
3934 * user can move to. Tasks can be moved to the foreground and background;
3935 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003936 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003937 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3938 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003939 *
3940 * <p>This flag is generally used by activities that want
3941 * to present a "launcher" style behavior: they give the user a list of
3942 * separate things that can be done, which otherwise run completely
3943 * independently of the activity launching them.
3944 *
3945 * <p>When using this flag, if a task is already running for the activity
3946 * you are now starting, then a new activity will not be started; instead,
3947 * the current task will simply be brought to the front of the screen with
3948 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3949 * to disable this behavior.
3950 *
3951 * <p>This flag can not be used when the caller is requesting a result from
3952 * the activity being launched.
3953 */
3954 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3955 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003956 * This flag is used to create a new task and launch an activity into it.
3957 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3958 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3959 * search through existing tasks for ones matching this Intent. Only if no such
3960 * task is found would a new task be created. When paired with
3961 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3962 * the search for a matching task and unconditionally start a new task.
3963 *
3964 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3965 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003966 * top-level application launcher.</strong> Used in conjunction with
3967 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3968 * behavior of bringing an existing task to the foreground. When set,
3969 * a new task is <em>always</em> started to host the Activity for the
3970 * Intent, regardless of whether there is already an existing task running
3971 * the same thing.
3972 *
3973 * <p><strong>Because the default system does not include graphical task management,
3974 * you should not use this flag unless you provide some way for a user to
3975 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003976 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003977 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3978 * creating new document tasks.
3979 *
3980 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003981 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003982 *
Scott Main7aee61f2011-02-08 11:25:01 -08003983 * <p>See
3984 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3985 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003986 *
3987 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3988 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003989 */
3990 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3991 /**
3992 * If set, and the activity being launched is already running in the
3993 * current task, then instead of launching a new instance of that activity,
3994 * all of the other activities on top of it will be closed and this Intent
3995 * will be delivered to the (now on top) old activity as a new Intent.
3996 *
3997 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3998 * If D calls startActivity() with an Intent that resolves to the component
3999 * of activity B, then C and D will be finished and B receive the given
4000 * Intent, resulting in the stack now being: A, B.
4001 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004002 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004003 * either receive the new intent you are starting here in its
4004 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004005 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004006 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4007 * the same intent, then it will be finished and re-created; for all other
4008 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4009 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004010 *
4011 * <p>This launch mode can also be used to good effect in conjunction with
4012 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4013 * of a task, it will bring any currently running instance of that task
4014 * to the foreground, and then clear it to its root state. This is
4015 * especially useful, for example, when launching an activity from the
4016 * notification manager.
4017 *
Scott Main7aee61f2011-02-08 11:25:01 -08004018 * <p>See
4019 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4020 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004021 */
4022 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4023 /**
4024 * If set and this intent is being used to launch a new activity from an
4025 * existing one, then the reply target of the existing activity will be
4026 * transfered to the new activity. This way the new activity can call
4027 * {@link android.app.Activity#setResult} and have that result sent back to
4028 * the reply target of the original activity.
4029 */
4030 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4031 /**
4032 * If set and this intent is being used to launch a new activity from an
4033 * existing one, the current activity will not be counted as the top
4034 * activity for deciding whether the new intent should be delivered to
4035 * the top instead of starting a new one. The previous activity will
4036 * be used as the top, with the assumption being that the current activity
4037 * will finish itself immediately.
4038 */
4039 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4040 /**
4041 * If set, the new activity is not kept in the list of recently launched
4042 * activities.
4043 */
4044 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4045 /**
4046 * This flag is not normally set by application code, but set for you by
4047 * the system as described in the
4048 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4049 * launchMode} documentation for the singleTask mode.
4050 */
4051 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4052 /**
4053 * If set, and this activity is either being started in a new task or
4054 * bringing to the top an existing task, then it will be launched as
4055 * the front door of the task. This will result in the application of
4056 * any affinities needed to have that task in the proper state (either
4057 * moving activities to or from it), or simply resetting that task to
4058 * its initial state if needed.
4059 */
4060 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4061 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004062 * This flag is not normally set by application code, but set for you by
4063 * the system if this activity is being launched from history
4064 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004065 */
4066 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004067 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004068 * @deprecated As of API 21 this performs identically to
4069 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004070 */
4071 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004072 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004073 * This flag is used to open a document into a new task rooted at the activity launched
4074 * by this Intent. Through the use of this flag, or its equivalent attribute,
4075 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004076 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004077 *
Craig Mautner026596b2014-05-21 15:35:44 -07004078 * <p>The use of the activity attribute form of this,
4079 * {@link android.R.attr#documentLaunchMode}, is
4080 * preferred over the Intent flag described here. The attribute form allows the
4081 * Activity to specify multiple document behavior for all launchers of the Activity
4082 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004083 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004084 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4085 * it is kept after the activity is finished is different than the use of
4086 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4087 * this flag is being used to create a new recents entry, then by default that entry
4088 * will be removed once the activity is finished. You can modify this behavior with
4089 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4090 *
Craig Mautner026596b2014-05-21 15:35:44 -07004091 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4092 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4093 * equivalent of the Activity manifest specifying {@link
4094 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4095 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4096 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004097 *
Craig Mautner026596b2014-05-21 15:35:44 -07004098 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004099 *
Craig Mautner026596b2014-05-21 15:35:44 -07004100 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004101 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4102 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004103 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004104 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004105 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004106 * callback from occurring on the current frontmost activity before it is
4107 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004108 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004109 * <p>Typically, an activity can rely on that callback to indicate that an
4110 * explicit user action has caused their activity to be moved out of the
4111 * foreground. The callback marks an appropriate point in the activity's
4112 * lifecycle for it to dismiss any notifications that it intends to display
4113 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004114 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004115 * <p>If an activity is ever started via any non-user-driven events such as
4116 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4117 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004118 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004119 */
4120 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004121 /**
4122 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4123 * this flag will cause the launched activity to be brought to the front of its
4124 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004125 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004126 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4127 * If D calls startActivity() with an Intent that resolves to the component
4128 * of activity B, then B will be brought to the front of the history stack,
4129 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004130 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004131 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004132 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004133 */
4134 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004135 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004136 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4137 * this flag will prevent the system from applying an activity transition
4138 * animation to go to the next activity state. This doesn't mean an
4139 * animation will never run -- if another activity change happens that doesn't
4140 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004141 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004142 * when you are going to do a series of activity operations but the
4143 * animation seen by the user shouldn't be driven by the first activity
4144 * change but rather a later one.
4145 */
4146 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4147 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004148 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4149 * this flag will cause any existing task that would be associated with the
4150 * activity to be cleared before the activity is started. That is, the activity
4151 * becomes the new root of an otherwise empty task, and any old activities
4152 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4153 */
4154 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4155 /**
4156 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4157 * this flag will cause a newly launching task to be placed on top of the current
4158 * home activity task (if there is one). That is, pressing back from the task
4159 * will always return the user to home even if that was not the last activity they
4160 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4161 */
4162 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4163 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004164 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4165 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004166 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004167 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004168 * this flag. When set and the task's activity is finished, the recents
4169 * entry will remain in the interface for the user to re-launch it, like a
4170 * recents entry for a top-level application.
4171 * <p>
4172 * The receiving activity can override this request with
4173 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4174 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004175 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004176 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004177 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004178
4179 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004180 * If set, when sending a broadcast only registered receivers will be
4181 * called -- no BroadcastReceiver components will be launched.
4182 */
4183 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004184 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004185 * If set, when sending a broadcast the new broadcast will replace
4186 * any existing pending broadcast that matches it. Matching is defined
4187 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4188 * true for the intents of the two broadcasts. When a match is found,
4189 * the new broadcast (and receivers associated with it) will replace the
4190 * existing one in the pending broadcast list, remaining at the same
4191 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004192 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004193 * <p>This flag is most typically used with sticky broadcasts, which
4194 * only care about delivering the most recent values of the broadcast
4195 * to their receivers.
4196 */
4197 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4198 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004199 * If set, when sending a broadcast the recipient is allowed to run at
4200 * foreground priority, with a shorter timeout interval. During normal
4201 * broadcasts the receivers are not automatically hoisted out of the
4202 * background priority class.
4203 */
4204 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4205 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004206 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4207 * They can still propagate results through to later receivers, but they can not prevent
4208 * later receivers from seeing the broadcast.
4209 */
4210 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4211 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004212 * If set, when sending a broadcast <i>before boot has completed</i> only
4213 * registered receivers will be called -- no BroadcastReceiver components
4214 * will be launched. Sticky intent state will be recorded properly even
4215 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4216 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004217 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004218 * <p>This flag is only for use by system sevices as a convenience to
4219 * avoid having to implement a more complex mechanism around detection
4220 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004221 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004222 * @hide
4223 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004224 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004225 /**
4226 * Set when this broadcast is for a boot upgrade, a special mode that
4227 * allows the broadcast to be sent before the system is ready and launches
4228 * the app process with no providers running in it.
4229 * @hide
4230 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004231 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004232
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004233 /**
4234 * @hide Flags that can't be changed with PendingIntent.
4235 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004236 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4237 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4238 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004239
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004240 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004241 // ---------------------------------------------------------------------
4242 // toUri() and parseUri() options.
4243
4244 /**
4245 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4246 * always has the "intent:" scheme. This syntax can be used when you want
4247 * to later disambiguate between URIs that are intended to describe an
4248 * Intent vs. all others that should be treated as raw URIs. When used
4249 * with {@link #parseUri}, any other scheme will result in a generic
4250 * VIEW action for that raw URI.
4251 */
4252 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004253
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004254 /**
4255 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4256 * always has the "android-app:" scheme. This is a variation of
4257 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4258 * http/https URI being delivered to a specific package name. The format
4259 * is:
4260 *
4261 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004262 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004263 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004264 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4265 * you must also include a scheme; including a path also requires both a host and a scheme.
4266 * The final #Intent; fragment can be used without a scheme, host, or path.
4267 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004268 * used with intents that have a {@link #setSelector}, since the base intent
4269 * will always have an explicit package name.</p>
4270 *
4271 * <p>Some examples of how this scheme maps to Intent objects:</p>
4272 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4273 * <colgroup align="left" />
4274 * <colgroup align="left" />
4275 * <thead>
4276 * <tr><th>URI</th> <th>Intent</th></tr>
4277 * </thead>
4278 *
4279 * <tbody>
4280 * <tr><td><code>android-app://com.example.app</code></td>
4281 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4282 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4283 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4284 * </table></td>
4285 * </tr>
4286 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4287 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4288 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4289 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4290 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4291 * </table></td>
4292 * </tr>
4293 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4294 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4295 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4296 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4297 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4298 * </table></td>
4299 * </tr>
4300 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4301 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4302 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4303 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4304 * </table></td>
4305 * </tr>
4306 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4307 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4308 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4309 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4310 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4311 * </table></td>
4312 * </tr>
4313 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;<br />i.some_int=100;S.some_str=hello;end</code></td>
4314 * <td><table border="" style="margin:0" >
4315 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4316 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4317 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4318 * </table></td>
4319 * </tr>
4320 * </tbody>
4321 * </table>
4322 */
4323 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4324
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004325 /**
4326 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4327 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4328 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4329 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4330 * generated Intent can not cause unexpected data access to happen.
4331 *
4332 * <p>If you do not trust the source of the URI being parsed, you should still do further
4333 * processing to protect yourself from it. In particular, when using it to start an
4334 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4335 * that can handle it.</p>
4336 */
4337 public static final int URI_ALLOW_UNSAFE = 1<<2;
4338
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004339 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004340
4341 private String mAction;
4342 private Uri mData;
4343 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004344 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004345 private ComponentName mComponent;
4346 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004347 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004348 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004349 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004350 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004351 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004352 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004353
4354 // ---------------------------------------------------------------------
4355
4356 /**
4357 * Create an empty intent.
4358 */
4359 public Intent() {
4360 }
4361
4362 /**
4363 * Copy constructor.
4364 */
4365 public Intent(Intent o) {
4366 this.mAction = o.mAction;
4367 this.mData = o.mData;
4368 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004369 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004370 this.mComponent = o.mComponent;
4371 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004372 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004373 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004374 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004375 }
4376 if (o.mExtras != null) {
4377 this.mExtras = new Bundle(o.mExtras);
4378 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004379 if (o.mSourceBounds != null) {
4380 this.mSourceBounds = new Rect(o.mSourceBounds);
4381 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004382 if (o.mSelector != null) {
4383 this.mSelector = new Intent(o.mSelector);
4384 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004385 if (o.mClipData != null) {
4386 this.mClipData = new ClipData(o.mClipData);
4387 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004388 }
4389
4390 @Override
4391 public Object clone() {
4392 return new Intent(this);
4393 }
4394
4395 private Intent(Intent o, boolean all) {
4396 this.mAction = o.mAction;
4397 this.mData = o.mData;
4398 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004399 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004400 this.mComponent = o.mComponent;
4401 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004402 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004403 }
4404 }
4405
4406 /**
4407 * Make a clone of only the parts of the Intent that are relevant for
4408 * filter matching: the action, data, type, component, and categories.
4409 */
4410 public Intent cloneFilter() {
4411 return new Intent(this, false);
4412 }
4413
4414 /**
4415 * Create an intent with a given action. All other fields (data, type,
4416 * class) are null. Note that the action <em>must</em> be in a
4417 * namespace because Intents are used globally in the system -- for
4418 * example the system VIEW action is android.intent.action.VIEW; an
4419 * application's custom action would be something like
4420 * com.google.app.myapp.CUSTOM_ACTION.
4421 *
4422 * @param action The Intent action, such as ACTION_VIEW.
4423 */
4424 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004425 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004426 }
4427
4428 /**
4429 * Create an intent with a given action and for a given data url. Note
4430 * that the action <em>must</em> be in a namespace because Intents are
4431 * used globally in the system -- for example the system VIEW action is
4432 * android.intent.action.VIEW; an application's custom action would be
4433 * something like com.google.app.myapp.CUSTOM_ACTION.
4434 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004435 * <p><em>Note: scheme and host name matching in the Android framework is
4436 * case-sensitive, unlike the formal RFC. As a result,
4437 * you should always ensure that you write your Uri with these elements
4438 * using lower case letters, and normalize any Uris you receive from
4439 * outside of Android to ensure the scheme and host is lower case.</em></p>
4440 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004441 * @param action The Intent action, such as ACTION_VIEW.
4442 * @param uri The Intent data URI.
4443 */
4444 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004445 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004446 mData = uri;
4447 }
4448
4449 /**
4450 * Create an intent for a specific component. All other fields (action, data,
4451 * type, class) are null, though they can be modified later with explicit
4452 * calls. This provides a convenient way to create an intent that is
4453 * intended to execute a hard-coded class name, rather than relying on the
4454 * system to find an appropriate class for you; see {@link #setComponent}
4455 * for more information on the repercussions of this.
4456 *
4457 * @param packageContext A Context of the application package implementing
4458 * this class.
4459 * @param cls The component class that is to be used for the intent.
4460 *
4461 * @see #setClass
4462 * @see #setComponent
4463 * @see #Intent(String, android.net.Uri , Context, Class)
4464 */
4465 public Intent(Context packageContext, Class<?> cls) {
4466 mComponent = new ComponentName(packageContext, cls);
4467 }
4468
4469 /**
4470 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004471 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004472 * construct the Intent and then calling {@link #setClass} to set its
4473 * class.
4474 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004475 * <p><em>Note: scheme and host name matching in the Android framework is
4476 * case-sensitive, unlike the formal RFC. As a result,
4477 * you should always ensure that you write your Uri with these elements
4478 * using lower case letters, and normalize any Uris you receive from
4479 * outside of Android to ensure the scheme and host is lower case.</em></p>
4480 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004481 * @param action The Intent action, such as ACTION_VIEW.
4482 * @param uri The Intent data URI.
4483 * @param packageContext A Context of the application package implementing
4484 * this class.
4485 * @param cls The component class that is to be used for the intent.
4486 *
4487 * @see #Intent(String, android.net.Uri)
4488 * @see #Intent(Context, Class)
4489 * @see #setClass
4490 * @see #setComponent
4491 */
4492 public Intent(String action, Uri uri,
4493 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004494 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004495 mData = uri;
4496 mComponent = new ComponentName(packageContext, cls);
4497 }
4498
4499 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004500 * Create an intent to launch the main (root) activity of a task. This
4501 * is the Intent that is started when the application's is launched from
4502 * Home. For anything else that wants to launch an application in the
4503 * same way, it is important that they use an Intent structured the same
4504 * way, and can use this function to ensure this is the case.
4505 *
4506 * <p>The returned Intent has the given Activity component as its explicit
4507 * component, {@link #ACTION_MAIN} as its action, and includes the
4508 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4509 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4510 * to do that through {@link #addFlags(int)} on the returned Intent.
4511 *
4512 * @param mainActivity The main activity component that this Intent will
4513 * launch.
4514 * @return Returns a newly created Intent that can be used to launch the
4515 * activity as a main application entry.
4516 *
4517 * @see #setClass
4518 * @see #setComponent
4519 */
4520 public static Intent makeMainActivity(ComponentName mainActivity) {
4521 Intent intent = new Intent(ACTION_MAIN);
4522 intent.setComponent(mainActivity);
4523 intent.addCategory(CATEGORY_LAUNCHER);
4524 return intent;
4525 }
4526
4527 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004528 * Make an Intent for the main activity of an application, without
4529 * specifying a specific activity to run but giving a selector to find
4530 * the activity. This results in a final Intent that is structured
4531 * the same as when the application is launched from
4532 * Home. For anything else that wants to launch an application in the
4533 * same way, it is important that they use an Intent structured the same
4534 * way, and can use this function to ensure this is the case.
4535 *
4536 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4537 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4538 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4539 * to do that through {@link #addFlags(int)} on the returned Intent.
4540 *
4541 * @param selectorAction The action name of the Intent's selector.
4542 * @param selectorCategory The name of a category to add to the Intent's
4543 * selector.
4544 * @return Returns a newly created Intent that can be used to launch the
4545 * activity as a main application entry.
4546 *
4547 * @see #setSelector(Intent)
4548 */
4549 public static Intent makeMainSelectorActivity(String selectorAction,
4550 String selectorCategory) {
4551 Intent intent = new Intent(ACTION_MAIN);
4552 intent.addCategory(CATEGORY_LAUNCHER);
4553 Intent selector = new Intent();
4554 selector.setAction(selectorAction);
4555 selector.addCategory(selectorCategory);
4556 intent.setSelector(selector);
4557 return intent;
4558 }
4559
4560 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004561 * Make an Intent that can be used to re-launch an application's task
4562 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4563 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4564 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4565 *
4566 * @param mainActivity The activity component that is the root of the
4567 * task; this is the activity that has been published in the application's
4568 * manifest as the main launcher icon.
4569 *
4570 * @return Returns a newly created Intent that can be used to relaunch the
4571 * activity's task in its root state.
4572 */
4573 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4574 Intent intent = makeMainActivity(mainActivity);
4575 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4576 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4577 return intent;
4578 }
4579
4580 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004581 * Call {@link #parseUri} with 0 flags.
4582 * @deprecated Use {@link #parseUri} instead.
4583 */
4584 @Deprecated
4585 public static Intent getIntent(String uri) throws URISyntaxException {
4586 return parseUri(uri, 0);
4587 }
Tom Taylord4a47292009-12-21 13:59:18 -08004588
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004589 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004590 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004591 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004592 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004593 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004594 *
4595 * <p>The URI given here must not be relative -- that is, it must include
4596 * the scheme and full path.
4597 *
4598 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004599 * @param flags Additional processing flags. Either 0,
4600 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004601 *
4602 * @return Intent The newly created Intent object.
4603 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004604 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4605 * it bad (as parsed by the Uri class) or the Intent data within the
4606 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004607 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004608 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004609 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004610 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004611 int i = 0;
4612 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004613 final boolean androidApp = uri.startsWith("android-app:");
4614
4615 // Validate intent scheme if requested.
4616 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4617 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004618 Intent intent = new Intent(ACTION_VIEW);
4619 try {
4620 intent.setData(Uri.parse(uri));
4621 } catch (IllegalArgumentException e) {
4622 throw new URISyntaxException(uri, e.getMessage());
4623 }
4624 return intent;
4625 }
4626 }
Tom Taylord4a47292009-12-21 13:59:18 -08004627
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004628 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004629 // simple case
4630 if (i == -1) {
4631 if (!androidApp) {
4632 return new Intent(ACTION_VIEW, Uri.parse(uri));
4633 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004634
4635 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004636 } else if (!uri.startsWith("#Intent;", i)) {
4637 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004638 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004639 } else {
4640 i = -1;
4641 }
4642 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004643
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004644 // new format
4645 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004646 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004647 boolean explicitAction = false;
4648 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004649
4650 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004651 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004652 String data;
4653 if (i >= 0) {
4654 data = uri.substring(0, i);
4655 i += 8; // length of "#Intent;"
4656 } else {
4657 data = uri;
4658 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004660 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004661 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004662 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004663 if (eq < 0) eq = i-1;
4664 int semi = uri.indexOf(';', i);
4665 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004666
4667 // action
4668 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004669 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004670 if (!inSelector) {
4671 explicitAction = true;
4672 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004673 }
4674
4675 // categories
4676 else if (uri.startsWith("category=", i)) {
4677 intent.addCategory(value);
4678 }
4679
4680 // type
4681 else if (uri.startsWith("type=", i)) {
4682 intent.mType = value;
4683 }
4684
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004685 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004686 else if (uri.startsWith("launchFlags=", i)) {
4687 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004688 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4689 intent.mFlags &= ~IMMUTABLE_FLAGS;
4690 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004691 }
4692
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004693 // package
4694 else if (uri.startsWith("package=", i)) {
4695 intent.mPackage = value;
4696 }
4697
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004698 // component
4699 else if (uri.startsWith("component=", i)) {
4700 intent.mComponent = ComponentName.unflattenFromString(value);
4701 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004702
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004703 // scheme
4704 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004705 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004706 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004707 } else {
4708 scheme = value;
4709 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004710 }
4711
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004712 // source bounds
4713 else if (uri.startsWith("sourceBounds=", i)) {
4714 intent.mSourceBounds = Rect.unflattenFromString(value);
4715 }
4716
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004717 // selector
4718 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4719 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004720 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004721 }
4722
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004723 // extra
4724 else {
4725 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004726 // create Bundle if it doesn't already exist
4727 if (intent.mExtras == null) intent.mExtras = new Bundle();
4728 Bundle b = intent.mExtras;
4729 // add EXTRA
4730 if (uri.startsWith("S.", i)) b.putString(key, value);
4731 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4732 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4733 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4734 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4735 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4736 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4737 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4738 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4739 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4740 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004741
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004742 // move to the next item
4743 i = semi + 1;
4744 }
4745
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004746 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004747 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004748 if (baseIntent.mPackage == null) {
4749 baseIntent.setSelector(intent);
4750 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004751 intent = baseIntent;
4752 }
4753
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004754 if (data != null) {
4755 if (data.startsWith("intent:")) {
4756 data = data.substring(7);
4757 if (scheme != null) {
4758 data = scheme + ':' + data;
4759 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004760 } else if (data.startsWith("android-app:")) {
4761 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
4762 // Correctly formed android-app, first part is package name.
4763 int end = data.indexOf('/', 14);
4764 if (end < 0) {
4765 // All we have is a package name.
4766 intent.mPackage = data.substring(14);
4767 if (!explicitAction) {
4768 intent.setAction(ACTION_MAIN);
4769 }
4770 data = "";
4771 } else {
4772 // Target the Intent at the given package name always.
4773 String authority = null;
4774 intent.mPackage = data.substring(14, end);
4775 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004776 if ((end+1) < data.length()) {
4777 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
4778 // Found a scheme, remember it.
4779 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004780 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004781 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
4782 // Found a authority, remember it.
4783 authority = data.substring(end+1, newEnd);
4784 end = newEnd;
4785 }
4786 } else {
4787 // All we have is a scheme.
4788 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004789 }
4790 }
4791 if (scheme == null) {
4792 // If there was no scheme, then this just targets the package.
4793 if (!explicitAction) {
4794 intent.setAction(ACTION_MAIN);
4795 }
4796 data = "";
4797 } else if (authority == null) {
4798 data = scheme + ":";
4799 } else {
4800 data = scheme + "://" + authority + data.substring(end);
4801 }
4802 }
4803 } else {
4804 data = "";
4805 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004806 }
Tom Taylord4a47292009-12-21 13:59:18 -08004807
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004808 if (data.length() > 0) {
4809 try {
4810 intent.mData = Uri.parse(data);
4811 } catch (IllegalArgumentException e) {
4812 throw new URISyntaxException(uri, e.getMessage());
4813 }
4814 }
4815 }
Tom Taylord4a47292009-12-21 13:59:18 -08004816
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004817 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004818
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004819 } catch (IndexOutOfBoundsException e) {
4820 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4821 }
4822 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004823
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004824 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004825 return getIntentOld(uri, 0);
4826 }
4827
4828 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004829 Intent intent;
4830
4831 int i = uri.lastIndexOf('#');
4832 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004833 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004834 final int intentFragmentStart = i;
4835 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004836
4837 i++;
4838
4839 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004840 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004841 i += 7;
4842 int j = uri.indexOf(')', i);
4843 action = uri.substring(i, j);
4844 i = j + 1;
4845 }
4846
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004847 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004848
4849 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004850 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004851 i += 11;
4852 int j = uri.indexOf(')', i);
4853 while (i < j) {
4854 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004855 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004856 if (i < sep) {
4857 intent.addCategory(uri.substring(i, sep));
4858 }
4859 i = sep + 1;
4860 }
4861 i = j + 1;
4862 }
4863
4864 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004865 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004866 i += 5;
4867 int j = uri.indexOf(')', i);
4868 intent.mType = uri.substring(i, j);
4869 i = j + 1;
4870 }
4871
4872 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004873 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004874 i += 12;
4875 int j = uri.indexOf(')', i);
4876 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004877 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4878 intent.mFlags &= ~IMMUTABLE_FLAGS;
4879 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004880 i = j + 1;
4881 }
4882
4883 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004884 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004885 i += 10;
4886 int j = uri.indexOf(')', i);
4887 int sep = uri.indexOf('!', i);
4888 if (sep >= 0 && sep < j) {
4889 String pkg = uri.substring(i, sep);
4890 String cls = uri.substring(sep + 1, j);
4891 intent.mComponent = new ComponentName(pkg, cls);
4892 }
4893 i = j + 1;
4894 }
4895
4896 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004897 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004898 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004899
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004900 final int closeParen = uri.indexOf(')', i);
4901 if (closeParen == -1) throw new URISyntaxException(uri,
4902 "EXTRA missing trailing ')'", i);
4903
4904 while (i < closeParen) {
4905 // fetch the key value
4906 int j = uri.indexOf('=', i);
4907 if (j <= i + 1 || i >= closeParen) {
4908 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4909 }
4910 char type = uri.charAt(i);
4911 i++;
4912 String key = uri.substring(i, j);
4913 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004914
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004915 // get type-value
4916 j = uri.indexOf('!', i);
4917 if (j == -1 || j >= closeParen) j = closeParen;
4918 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4919 String value = uri.substring(i, j);
4920 i = j;
4921
4922 // create Bundle if it doesn't already exist
4923 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004924
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004925 // add item to bundle
4926 try {
4927 switch (type) {
4928 case 'S':
4929 intent.mExtras.putString(key, Uri.decode(value));
4930 break;
4931 case 'B':
4932 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4933 break;
4934 case 'b':
4935 intent.mExtras.putByte(key, Byte.parseByte(value));
4936 break;
4937 case 'c':
4938 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4939 break;
4940 case 'd':
4941 intent.mExtras.putDouble(key, Double.parseDouble(value));
4942 break;
4943 case 'f':
4944 intent.mExtras.putFloat(key, Float.parseFloat(value));
4945 break;
4946 case 'i':
4947 intent.mExtras.putInt(key, Integer.parseInt(value));
4948 break;
4949 case 'l':
4950 intent.mExtras.putLong(key, Long.parseLong(value));
4951 break;
4952 case 's':
4953 intent.mExtras.putShort(key, Short.parseShort(value));
4954 break;
4955 default:
4956 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4957 }
4958 } catch (NumberFormatException e) {
4959 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4960 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004961
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004962 char ch = uri.charAt(i);
4963 if (ch == ')') break;
4964 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4965 i++;
4966 }
4967 }
4968
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004969 if (isIntentFragment) {
4970 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4971 } else {
4972 intent.mData = Uri.parse(uri);
4973 }
Tom Taylord4a47292009-12-21 13:59:18 -08004974
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004975 if (intent.mAction == null) {
4976 // By default, if no action is specified, then use VIEW.
4977 intent.mAction = ACTION_VIEW;
4978 }
4979
4980 } else {
4981 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4982 }
4983
4984 return intent;
4985 }
4986
4987 /**
4988 * Retrieve the general action to be performed, such as
4989 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4990 * the information in the intent should be interpreted -- most importantly,
4991 * what to do with the data returned by {@link #getData}.
4992 *
4993 * @return The action of this intent or null if none is specified.
4994 *
4995 * @see #setAction
4996 */
4997 public String getAction() {
4998 return mAction;
4999 }
5000
5001 /**
5002 * Retrieve data this intent is operating on. This URI specifies the name
5003 * of the data; often it uses the content: scheme, specifying data in a
5004 * content provider. Other schemes may be handled by specific activities,
5005 * such as http: by the web browser.
5006 *
5007 * @return The URI of the data this intent is targeting or null.
5008 *
5009 * @see #getScheme
5010 * @see #setData
5011 */
5012 public Uri getData() {
5013 return mData;
5014 }
5015
5016 /**
5017 * The same as {@link #getData()}, but returns the URI as an encoded
5018 * String.
5019 */
5020 public String getDataString() {
5021 return mData != null ? mData.toString() : null;
5022 }
5023
5024 /**
5025 * Return the scheme portion of the intent's data. If the data is null or
5026 * does not include a scheme, null is returned. Otherwise, the scheme
5027 * prefix without the final ':' is returned, i.e. "http".
5028 *
5029 * <p>This is the same as calling getData().getScheme() (and checking for
5030 * null data).
5031 *
5032 * @return The scheme of this intent.
5033 *
5034 * @see #getData
5035 */
5036 public String getScheme() {
5037 return mData != null ? mData.getScheme() : null;
5038 }
5039
5040 /**
5041 * Retrieve any explicit MIME type included in the intent. This is usually
5042 * null, as the type is determined by the intent data.
5043 *
5044 * @return If a type was manually set, it is returned; else null is
5045 * returned.
5046 *
5047 * @see #resolveType(ContentResolver)
5048 * @see #setType
5049 */
5050 public String getType() {
5051 return mType;
5052 }
5053
5054 /**
5055 * Return the MIME data type of this intent. If the type field is
5056 * explicitly set, that is simply returned. Otherwise, if the data is set,
5057 * the type of that data is returned. If neither fields are set, a null is
5058 * returned.
5059 *
5060 * @return The MIME type of this intent.
5061 *
5062 * @see #getType
5063 * @see #resolveType(ContentResolver)
5064 */
5065 public String resolveType(Context context) {
5066 return resolveType(context.getContentResolver());
5067 }
5068
5069 /**
5070 * Return the MIME data type of this intent. If the type field is
5071 * explicitly set, that is simply returned. Otherwise, if the data is set,
5072 * the type of that data is returned. If neither fields are set, a null is
5073 * returned.
5074 *
5075 * @param resolver A ContentResolver that can be used to determine the MIME
5076 * type of the intent's data.
5077 *
5078 * @return The MIME type of this intent.
5079 *
5080 * @see #getType
5081 * @see #resolveType(Context)
5082 */
5083 public String resolveType(ContentResolver resolver) {
5084 if (mType != null) {
5085 return mType;
5086 }
5087 if (mData != null) {
5088 if ("content".equals(mData.getScheme())) {
5089 return resolver.getType(mData);
5090 }
5091 }
5092 return null;
5093 }
5094
5095 /**
5096 * Return the MIME data type of this intent, only if it will be needed for
5097 * intent resolution. This is not generally useful for application code;
5098 * it is used by the frameworks for communicating with back-end system
5099 * services.
5100 *
5101 * @param resolver A ContentResolver that can be used to determine the MIME
5102 * type of the intent's data.
5103 *
5104 * @return The MIME type of this intent, or null if it is unknown or not
5105 * needed.
5106 */
5107 public String resolveTypeIfNeeded(ContentResolver resolver) {
5108 if (mComponent != null) {
5109 return mType;
5110 }
5111 return resolveType(resolver);
5112 }
5113
5114 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005115 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005116 *
5117 * @param category The category to check.
5118 *
5119 * @return boolean True if the intent contains the category, else false.
5120 *
5121 * @see #getCategories
5122 * @see #addCategory
5123 */
5124 public boolean hasCategory(String category) {
5125 return mCategories != null && mCategories.contains(category);
5126 }
5127
5128 /**
5129 * Return the set of all categories in the intent. If there are no categories,
5130 * returns NULL.
5131 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005132 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005133 *
5134 * @see #hasCategory
5135 * @see #addCategory
5136 */
5137 public Set<String> getCategories() {
5138 return mCategories;
5139 }
5140
5141 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005142 * Return the specific selector associated with this Intent. If there is
5143 * none, returns null. See {@link #setSelector} for more information.
5144 *
5145 * @see #setSelector
5146 */
5147 public Intent getSelector() {
5148 return mSelector;
5149 }
5150
5151 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005152 * Return the {@link ClipData} associated with this Intent. If there is
5153 * none, returns null. See {@link #setClipData} for more information.
5154 *
John Spurlock125d1332013-11-25 11:58:37 -05005155 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005156 */
5157 public ClipData getClipData() {
5158 return mClipData;
5159 }
5160
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005161 /** @hide */
5162 public int getContentUserHint() {
5163 return mContentUserHint;
5164 }
5165
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005166 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005167 * Sets the ClassLoader that will be used when unmarshalling
5168 * any Parcelable values from the extras of this Intent.
5169 *
5170 * @param loader a ClassLoader, or null to use the default loader
5171 * at the time of unmarshalling.
5172 */
5173 public void setExtrasClassLoader(ClassLoader loader) {
5174 if (mExtras != null) {
5175 mExtras.setClassLoader(loader);
5176 }
5177 }
5178
5179 /**
5180 * Returns true if an extra value is associated with the given name.
5181 * @param name the extra's name
5182 * @return true if the given extra is present.
5183 */
5184 public boolean hasExtra(String name) {
5185 return mExtras != null && mExtras.containsKey(name);
5186 }
5187
5188 /**
5189 * Returns true if the Intent's extras contain a parcelled file descriptor.
5190 * @return true if the Intent contains a parcelled file descriptor.
5191 */
5192 public boolean hasFileDescriptors() {
5193 return mExtras != null && mExtras.hasFileDescriptors();
5194 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005195
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04005196 /** @hide */
5197 public void setAllowFds(boolean allowFds) {
5198 if (mExtras != null) {
5199 mExtras.setAllowFds(allowFds);
5200 }
5201 }
5202
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005203 /**
5204 * Retrieve extended data from the intent.
5205 *
5206 * @param name The name of the desired item.
5207 *
5208 * @return the value of an item that previously added with putExtra()
5209 * or null if none was found.
5210 *
5211 * @deprecated
5212 * @hide
5213 */
5214 @Deprecated
5215 public Object getExtra(String name) {
5216 return getExtra(name, null);
5217 }
5218
5219 /**
5220 * Retrieve extended data from the intent.
5221 *
5222 * @param name The name of the desired item.
5223 * @param defaultValue the value to be returned if no value of the desired
5224 * type is stored with the given name.
5225 *
5226 * @return the value of an item that previously added with putExtra()
5227 * or the default value if none was found.
5228 *
5229 * @see #putExtra(String, boolean)
5230 */
5231 public boolean getBooleanExtra(String name, boolean defaultValue) {
5232 return mExtras == null ? defaultValue :
5233 mExtras.getBoolean(name, defaultValue);
5234 }
5235
5236 /**
5237 * Retrieve extended data from the intent.
5238 *
5239 * @param name The name of the desired item.
5240 * @param defaultValue the value to be returned if no value of the desired
5241 * type is stored with the given name.
5242 *
5243 * @return the value of an item that previously added with putExtra()
5244 * or the default value if none was found.
5245 *
5246 * @see #putExtra(String, byte)
5247 */
5248 public byte getByteExtra(String name, byte defaultValue) {
5249 return mExtras == null ? defaultValue :
5250 mExtras.getByte(name, defaultValue);
5251 }
5252
5253 /**
5254 * Retrieve extended data from the intent.
5255 *
5256 * @param name The name of the desired item.
5257 * @param defaultValue the value to be returned if no value of the desired
5258 * type is stored with the given name.
5259 *
5260 * @return the value of an item that previously added with putExtra()
5261 * or the default value if none was found.
5262 *
5263 * @see #putExtra(String, short)
5264 */
5265 public short getShortExtra(String name, short defaultValue) {
5266 return mExtras == null ? defaultValue :
5267 mExtras.getShort(name, defaultValue);
5268 }
5269
5270 /**
5271 * Retrieve extended data from the intent.
5272 *
5273 * @param name The name of the desired item.
5274 * @param defaultValue the value to be returned if no value of the desired
5275 * type is stored with the given name.
5276 *
5277 * @return the value of an item that previously added with putExtra()
5278 * or the default value if none was found.
5279 *
5280 * @see #putExtra(String, char)
5281 */
5282 public char getCharExtra(String name, char defaultValue) {
5283 return mExtras == null ? defaultValue :
5284 mExtras.getChar(name, defaultValue);
5285 }
5286
5287 /**
5288 * Retrieve extended data from the intent.
5289 *
5290 * @param name The name of the desired item.
5291 * @param defaultValue the value to be returned if no value of the desired
5292 * type is stored with the given name.
5293 *
5294 * @return the value of an item that previously added with putExtra()
5295 * or the default value if none was found.
5296 *
5297 * @see #putExtra(String, int)
5298 */
5299 public int getIntExtra(String name, int defaultValue) {
5300 return mExtras == null ? defaultValue :
5301 mExtras.getInt(name, defaultValue);
5302 }
5303
5304 /**
5305 * Retrieve extended data from the intent.
5306 *
5307 * @param name The name of the desired item.
5308 * @param defaultValue the value to be returned if no value of the desired
5309 * type is stored with the given name.
5310 *
5311 * @return the value of an item that previously added with putExtra()
5312 * or the default value if none was found.
5313 *
5314 * @see #putExtra(String, long)
5315 */
5316 public long getLongExtra(String name, long defaultValue) {
5317 return mExtras == null ? defaultValue :
5318 mExtras.getLong(name, defaultValue);
5319 }
5320
5321 /**
5322 * Retrieve extended data from the intent.
5323 *
5324 * @param name The name of the desired item.
5325 * @param defaultValue the value to be returned if no value of the desired
5326 * type is stored with the given name.
5327 *
5328 * @return the value of an item that previously added with putExtra(),
5329 * or the default value if no such item is present
5330 *
5331 * @see #putExtra(String, float)
5332 */
5333 public float getFloatExtra(String name, float defaultValue) {
5334 return mExtras == null ? defaultValue :
5335 mExtras.getFloat(name, defaultValue);
5336 }
5337
5338 /**
5339 * Retrieve extended data from the intent.
5340 *
5341 * @param name The name of the desired item.
5342 * @param defaultValue the value to be returned if no value of the desired
5343 * type is stored with the given name.
5344 *
5345 * @return the value of an item that previously added with putExtra()
5346 * or the default value if none was found.
5347 *
5348 * @see #putExtra(String, double)
5349 */
5350 public double getDoubleExtra(String name, double defaultValue) {
5351 return mExtras == null ? defaultValue :
5352 mExtras.getDouble(name, defaultValue);
5353 }
5354
5355 /**
5356 * Retrieve extended data from the intent.
5357 *
5358 * @param name The name of the desired item.
5359 *
5360 * @return the value of an item that previously added with putExtra()
5361 * or null if no String value was found.
5362 *
5363 * @see #putExtra(String, String)
5364 */
5365 public String getStringExtra(String name) {
5366 return mExtras == null ? null : mExtras.getString(name);
5367 }
5368
5369 /**
5370 * Retrieve extended data from the intent.
5371 *
5372 * @param name The name of the desired item.
5373 *
5374 * @return the value of an item that previously added with putExtra()
5375 * or null if no CharSequence value was found.
5376 *
5377 * @see #putExtra(String, CharSequence)
5378 */
5379 public CharSequence getCharSequenceExtra(String name) {
5380 return mExtras == null ? null : mExtras.getCharSequence(name);
5381 }
5382
5383 /**
5384 * Retrieve extended data from the intent.
5385 *
5386 * @param name The name of the desired item.
5387 *
5388 * @return the value of an item that previously added with putExtra()
5389 * or null if no Parcelable value was found.
5390 *
5391 * @see #putExtra(String, Parcelable)
5392 */
5393 public <T extends Parcelable> T getParcelableExtra(String name) {
5394 return mExtras == null ? null : mExtras.<T>getParcelable(name);
5395 }
5396
5397 /**
5398 * Retrieve extended data from the intent.
5399 *
5400 * @param name The name of the desired item.
5401 *
5402 * @return the value of an item that previously added with putExtra()
5403 * or null if no Parcelable[] value was found.
5404 *
5405 * @see #putExtra(String, Parcelable[])
5406 */
5407 public Parcelable[] getParcelableArrayExtra(String name) {
5408 return mExtras == null ? null : mExtras.getParcelableArray(name);
5409 }
5410
5411 /**
5412 * Retrieve extended data from the intent.
5413 *
5414 * @param name The name of the desired item.
5415 *
5416 * @return the value of an item that previously added with putExtra()
5417 * or null if no ArrayList<Parcelable> value was found.
5418 *
5419 * @see #putParcelableArrayListExtra(String, ArrayList)
5420 */
5421 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
5422 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
5423 }
5424
5425 /**
5426 * Retrieve extended data from the intent.
5427 *
5428 * @param name The name of the desired item.
5429 *
5430 * @return the value of an item that previously added with putExtra()
5431 * or null if no Serializable value was found.
5432 *
5433 * @see #putExtra(String, Serializable)
5434 */
5435 public Serializable getSerializableExtra(String name) {
5436 return mExtras == null ? null : mExtras.getSerializable(name);
5437 }
5438
5439 /**
5440 * Retrieve extended data from the intent.
5441 *
5442 * @param name The name of the desired item.
5443 *
5444 * @return the value of an item that previously added with putExtra()
5445 * or null if no ArrayList<Integer> value was found.
5446 *
5447 * @see #putIntegerArrayListExtra(String, ArrayList)
5448 */
5449 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
5450 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
5451 }
5452
5453 /**
5454 * Retrieve extended data from the intent.
5455 *
5456 * @param name The name of the desired item.
5457 *
5458 * @return the value of an item that previously added with putExtra()
5459 * or null if no ArrayList<String> value was found.
5460 *
5461 * @see #putStringArrayListExtra(String, ArrayList)
5462 */
5463 public ArrayList<String> getStringArrayListExtra(String name) {
5464 return mExtras == null ? null : mExtras.getStringArrayList(name);
5465 }
5466
5467 /**
5468 * Retrieve extended data from the intent.
5469 *
5470 * @param name The name of the desired item.
5471 *
5472 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005473 * or null if no ArrayList<CharSequence> value was found.
5474 *
5475 * @see #putCharSequenceArrayListExtra(String, ArrayList)
5476 */
5477 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
5478 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5479 }
5480
5481 /**
5482 * Retrieve extended data from the intent.
5483 *
5484 * @param name The name of the desired item.
5485 *
5486 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005487 * or null if no boolean array value was found.
5488 *
5489 * @see #putExtra(String, boolean[])
5490 */
5491 public boolean[] getBooleanArrayExtra(String name) {
5492 return mExtras == null ? null : mExtras.getBooleanArray(name);
5493 }
5494
5495 /**
5496 * Retrieve extended data from the intent.
5497 *
5498 * @param name The name of the desired item.
5499 *
5500 * @return the value of an item that previously added with putExtra()
5501 * or null if no byte array value was found.
5502 *
5503 * @see #putExtra(String, byte[])
5504 */
5505 public byte[] getByteArrayExtra(String name) {
5506 return mExtras == null ? null : mExtras.getByteArray(name);
5507 }
5508
5509 /**
5510 * Retrieve extended data from the intent.
5511 *
5512 * @param name The name of the desired item.
5513 *
5514 * @return the value of an item that previously added with putExtra()
5515 * or null if no short array value was found.
5516 *
5517 * @see #putExtra(String, short[])
5518 */
5519 public short[] getShortArrayExtra(String name) {
5520 return mExtras == null ? null : mExtras.getShortArray(name);
5521 }
5522
5523 /**
5524 * Retrieve extended data from the intent.
5525 *
5526 * @param name The name of the desired item.
5527 *
5528 * @return the value of an item that previously added with putExtra()
5529 * or null if no char array value was found.
5530 *
5531 * @see #putExtra(String, char[])
5532 */
5533 public char[] getCharArrayExtra(String name) {
5534 return mExtras == null ? null : mExtras.getCharArray(name);
5535 }
5536
5537 /**
5538 * Retrieve extended data from the intent.
5539 *
5540 * @param name The name of the desired item.
5541 *
5542 * @return the value of an item that previously added with putExtra()
5543 * or null if no int array value was found.
5544 *
5545 * @see #putExtra(String, int[])
5546 */
5547 public int[] getIntArrayExtra(String name) {
5548 return mExtras == null ? null : mExtras.getIntArray(name);
5549 }
5550
5551 /**
5552 * Retrieve extended data from the intent.
5553 *
5554 * @param name The name of the desired item.
5555 *
5556 * @return the value of an item that previously added with putExtra()
5557 * or null if no long array value was found.
5558 *
5559 * @see #putExtra(String, long[])
5560 */
5561 public long[] getLongArrayExtra(String name) {
5562 return mExtras == null ? null : mExtras.getLongArray(name);
5563 }
5564
5565 /**
5566 * Retrieve extended data from the intent.
5567 *
5568 * @param name The name of the desired item.
5569 *
5570 * @return the value of an item that previously added with putExtra()
5571 * or null if no float array value was found.
5572 *
5573 * @see #putExtra(String, float[])
5574 */
5575 public float[] getFloatArrayExtra(String name) {
5576 return mExtras == null ? null : mExtras.getFloatArray(name);
5577 }
5578
5579 /**
5580 * Retrieve extended data from the intent.
5581 *
5582 * @param name The name of the desired item.
5583 *
5584 * @return the value of an item that previously added with putExtra()
5585 * or null if no double array value was found.
5586 *
5587 * @see #putExtra(String, double[])
5588 */
5589 public double[] getDoubleArrayExtra(String name) {
5590 return mExtras == null ? null : mExtras.getDoubleArray(name);
5591 }
5592
5593 /**
5594 * Retrieve extended data from the intent.
5595 *
5596 * @param name The name of the desired item.
5597 *
5598 * @return the value of an item that previously added with putExtra()
5599 * or null if no String array value was found.
5600 *
5601 * @see #putExtra(String, String[])
5602 */
5603 public String[] getStringArrayExtra(String name) {
5604 return mExtras == null ? null : mExtras.getStringArray(name);
5605 }
5606
5607 /**
5608 * Retrieve extended data from the intent.
5609 *
5610 * @param name The name of the desired item.
5611 *
5612 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005613 * or null if no CharSequence array value was found.
5614 *
5615 * @see #putExtra(String, CharSequence[])
5616 */
5617 public CharSequence[] getCharSequenceArrayExtra(String name) {
5618 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5619 }
5620
5621 /**
5622 * Retrieve extended data from the intent.
5623 *
5624 * @param name The name of the desired item.
5625 *
5626 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005627 * or null if no Bundle value was found.
5628 *
5629 * @see #putExtra(String, Bundle)
5630 */
5631 public Bundle getBundleExtra(String name) {
5632 return mExtras == null ? null : mExtras.getBundle(name);
5633 }
5634
5635 /**
5636 * Retrieve extended data from the intent.
5637 *
5638 * @param name The name of the desired item.
5639 *
5640 * @return the value of an item that previously added with putExtra()
5641 * or null if no IBinder value was found.
5642 *
5643 * @see #putExtra(String, IBinder)
5644 *
5645 * @deprecated
5646 * @hide
5647 */
5648 @Deprecated
5649 public IBinder getIBinderExtra(String name) {
5650 return mExtras == null ? null : mExtras.getIBinder(name);
5651 }
5652
5653 /**
5654 * Retrieve extended data from the intent.
5655 *
5656 * @param name The name of the desired item.
5657 * @param defaultValue The default value to return in case no item is
5658 * associated with the key 'name'
5659 *
5660 * @return the value of an item that previously added with putExtra()
5661 * or defaultValue if none was found.
5662 *
5663 * @see #putExtra
5664 *
5665 * @deprecated
5666 * @hide
5667 */
5668 @Deprecated
5669 public Object getExtra(String name, Object defaultValue) {
5670 Object result = defaultValue;
5671 if (mExtras != null) {
5672 Object result2 = mExtras.get(name);
5673 if (result2 != null) {
5674 result = result2;
5675 }
5676 }
5677
5678 return result;
5679 }
5680
5681 /**
5682 * Retrieves a map of extended data from the intent.
5683 *
5684 * @return the map of all extras previously added with putExtra(),
5685 * or null if none have been added.
5686 */
5687 public Bundle getExtras() {
5688 return (mExtras != null)
5689 ? new Bundle(mExtras)
5690 : null;
5691 }
5692
5693 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07005694 * Filter extras to only basic types.
5695 * @hide
5696 */
5697 public void removeUnsafeExtras() {
5698 if (mExtras != null) {
5699 mExtras.filterValues();
5700 }
5701 }
5702
5703 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005704 * Retrieve any special flags associated with this intent. You will
5705 * normally just set them with {@link #setFlags} and let the system
5706 * take the appropriate action with them.
5707 *
5708 * @return int The currently set flags.
5709 *
5710 * @see #setFlags
5711 */
5712 public int getFlags() {
5713 return mFlags;
5714 }
5715
Dianne Hackborne7f97212011-02-24 14:40:20 -08005716 /** @hide */
5717 public boolean isExcludingStopped() {
5718 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5719 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5720 }
5721
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005722 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005723 * Retrieve the application package name this Intent is limited to. When
5724 * resolving an Intent, if non-null this limits the resolution to only
5725 * components in the given application package.
5726 *
5727 * @return The name of the application package for the Intent.
5728 *
5729 * @see #resolveActivity
5730 * @see #setPackage
5731 */
5732 public String getPackage() {
5733 return mPackage;
5734 }
5735
5736 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005737 * Retrieve the concrete component associated with the intent. When receiving
5738 * an intent, this is the component that was found to best handle it (that is,
5739 * yourself) and will always be non-null; in all other cases it will be
5740 * null unless explicitly set.
5741 *
5742 * @return The name of the application component to handle the intent.
5743 *
5744 * @see #resolveActivity
5745 * @see #setComponent
5746 */
5747 public ComponentName getComponent() {
5748 return mComponent;
5749 }
5750
5751 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005752 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5753 * used as a hint to the receiver for animations and the like. Null means that there
5754 * is no source bounds.
5755 */
5756 public Rect getSourceBounds() {
5757 return mSourceBounds;
5758 }
5759
5760 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005761 * Return the Activity component that should be used to handle this intent.
5762 * The appropriate component is determined based on the information in the
5763 * intent, evaluated as follows:
5764 *
5765 * <p>If {@link #getComponent} returns an explicit class, that is returned
5766 * without any further consideration.
5767 *
5768 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5769 * category to be considered.
5770 *
5771 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5772 * action.
5773 *
5774 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5775 * this type.
5776 *
5777 * <p>If {@link #addCategory} has added any categories, the activity must
5778 * handle ALL of the categories specified.
5779 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005780 * <p>If {@link #getPackage} is non-NULL, only activity components in
5781 * that application package will be considered.
5782 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005783 * <p>If there are no activities that satisfy all of these conditions, a
5784 * null string is returned.
5785 *
5786 * <p>If multiple activities are found to satisfy the intent, the one with
5787 * the highest priority will be used. If there are multiple activities
5788 * with the same priority, the system will either pick the best activity
5789 * based on user preference, or resolve to a system class that will allow
5790 * the user to pick an activity and forward from there.
5791 *
5792 * <p>This method is implemented simply by calling
5793 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5794 * true.</p>
5795 * <p> This API is called for you as part of starting an activity from an
5796 * intent. You do not normally need to call it yourself.</p>
5797 *
5798 * @param pm The package manager with which to resolve the Intent.
5799 *
5800 * @return Name of the component implementing an activity that can
5801 * display the intent.
5802 *
5803 * @see #setComponent
5804 * @see #getComponent
5805 * @see #resolveActivityInfo
5806 */
5807 public ComponentName resolveActivity(PackageManager pm) {
5808 if (mComponent != null) {
5809 return mComponent;
5810 }
5811
5812 ResolveInfo info = pm.resolveActivity(
5813 this, PackageManager.MATCH_DEFAULT_ONLY);
5814 if (info != null) {
5815 return new ComponentName(
5816 info.activityInfo.applicationInfo.packageName,
5817 info.activityInfo.name);
5818 }
5819
5820 return null;
5821 }
5822
5823 /**
5824 * Resolve the Intent into an {@link ActivityInfo}
5825 * describing the activity that should execute the intent. Resolution
5826 * follows the same rules as described for {@link #resolveActivity}, but
5827 * you get back the completely information about the resolved activity
5828 * instead of just its class name.
5829 *
5830 * @param pm The package manager with which to resolve the Intent.
5831 * @param flags Addition information to retrieve as per
5832 * {@link PackageManager#getActivityInfo(ComponentName, int)
5833 * PackageManager.getActivityInfo()}.
5834 *
5835 * @return PackageManager.ActivityInfo
5836 *
5837 * @see #resolveActivity
5838 */
5839 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5840 ActivityInfo ai = null;
5841 if (mComponent != null) {
5842 try {
5843 ai = pm.getActivityInfo(mComponent, flags);
5844 } catch (PackageManager.NameNotFoundException e) {
5845 // ignore
5846 }
5847 } else {
5848 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005849 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005850 if (info != null) {
5851 ai = info.activityInfo;
5852 }
5853 }
5854
5855 return ai;
5856 }
5857
5858 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005859 * Special function for use by the system to resolve service
5860 * intents to system apps. Throws an exception if there are
5861 * multiple potential matches to the Intent. Returns null if
5862 * there are no matches.
5863 * @hide
5864 */
5865 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5866 if (mComponent != null) {
5867 return mComponent;
5868 }
5869
5870 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5871 if (results == null) {
5872 return null;
5873 }
5874 ComponentName comp = null;
5875 for (int i=0; i<results.size(); i++) {
5876 ResolveInfo ri = results.get(i);
5877 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5878 continue;
5879 }
5880 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5881 ri.serviceInfo.name);
5882 if (comp != null) {
5883 throw new IllegalStateException("Multiple system services handle " + this
5884 + ": " + comp + ", " + foundComp);
5885 }
5886 comp = foundComp;
5887 }
5888 return comp;
5889 }
5890
5891 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005892 * Set the general action to be performed.
5893 *
5894 * @param action An action name, such as ACTION_VIEW. Application-specific
5895 * actions should be prefixed with the vendor's package name.
5896 *
5897 * @return Returns the same Intent object, for chaining multiple calls
5898 * into a single statement.
5899 *
5900 * @see #getAction
5901 */
5902 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005903 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005904 return this;
5905 }
5906
5907 /**
5908 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005909 * clears any type that was previously set by {@link #setType} or
5910 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005911 *
Nick Pellyccae4122012-01-09 14:12:58 -08005912 * <p><em>Note: scheme matching in the Android framework is
5913 * case-sensitive, unlike the formal RFC. As a result,
5914 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005915 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005916 * {@link #setDataAndNormalize}
5917 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005918 *
Nick Pellyccae4122012-01-09 14:12:58 -08005919 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005920 *
5921 * @return Returns the same Intent object, for chaining multiple calls
5922 * into a single statement.
5923 *
5924 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005925 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005926 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005927 */
5928 public Intent setData(Uri data) {
5929 mData = data;
5930 mType = null;
5931 return this;
5932 }
5933
5934 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005935 * Normalize and set the data this intent is operating on.
5936 *
5937 * <p>This method automatically clears any type that was
5938 * previously set (for example, by {@link #setType}).
5939 *
5940 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005941 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005942 * so really this is just a convenience method for
5943 * <pre>
5944 * setData(data.normalize())
5945 * </pre>
5946 *
5947 * @param data The Uri of the data this intent is now targeting.
5948 *
5949 * @return Returns the same Intent object, for chaining multiple calls
5950 * into a single statement.
5951 *
5952 * @see #getData
5953 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005954 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005955 */
5956 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005957 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005958 }
5959
5960 /**
5961 * Set an explicit MIME data type.
5962 *
5963 * <p>This is used to create intents that only specify a type and not data,
5964 * for example to indicate the type of data to return.
5965 *
5966 * <p>This method automatically clears any data that was
5967 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005968 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005969 * <p><em>Note: MIME type matching in the Android framework is
5970 * case-sensitive, unlike formal RFC MIME types. As a result,
5971 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005972 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5973 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005974 *
5975 * @param type The MIME type of the data being handled by this intent.
5976 *
5977 * @return Returns the same Intent object, for chaining multiple calls
5978 * into a single statement.
5979 *
5980 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005981 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005982 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005983 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005984 */
5985 public Intent setType(String type) {
5986 mData = null;
5987 mType = type;
5988 return this;
5989 }
5990
5991 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005992 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005993 *
Nick Pellyccae4122012-01-09 14:12:58 -08005994 * <p>This is used to create intents that only specify a type and not data,
5995 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005996 *
Nick Pellyccae4122012-01-09 14:12:58 -08005997 * <p>This method automatically clears any data that was
5998 * previously set (for example by {@link #setData}).
5999 *
6000 * <p>The MIME type is normalized using
6001 * {@link #normalizeMimeType} before it is set,
6002 * so really this is just a convenience method for
6003 * <pre>
6004 * setType(Intent.normalizeMimeType(type))
6005 * </pre>
6006 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006007 * @param type The MIME type of the data being handled by this intent.
6008 *
6009 * @return Returns the same Intent object, for chaining multiple calls
6010 * into a single statement.
6011 *
Nick Pellyccae4122012-01-09 14:12:58 -08006012 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006013 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006014 * @see #normalizeMimeType
6015 */
6016 public Intent setTypeAndNormalize(String type) {
6017 return setType(normalizeMimeType(type));
6018 }
6019
6020 /**
6021 * (Usually optional) Set the data for the intent along with an explicit
6022 * MIME data type. This method should very rarely be used -- it allows you
6023 * to override the MIME type that would ordinarily be inferred from the
6024 * data with your own type given here.
6025 *
6026 * <p><em>Note: MIME type and Uri scheme matching in the
6027 * Android framework is case-sensitive, unlike the formal RFC definitions.
6028 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006029 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006030 * {@link #setDataAndTypeAndNormalize}
6031 * to ensure that they are converted to lower case.</em>
6032 *
6033 * @param data The Uri of the data this intent is now targeting.
6034 * @param type The MIME type of the data being handled by this intent.
6035 *
6036 * @return Returns the same Intent object, for chaining multiple calls
6037 * into a single statement.
6038 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006039 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006040 * @see #setData
6041 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006042 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006043 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006044 */
6045 public Intent setDataAndType(Uri data, String type) {
6046 mData = data;
6047 mType = type;
6048 return this;
6049 }
6050
6051 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006052 * (Usually optional) Normalize and set both the data Uri and an explicit
6053 * MIME data type. This method should very rarely be used -- it allows you
6054 * to override the MIME type that would ordinarily be inferred from the
6055 * data with your own type given here.
6056 *
6057 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006058 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006059 * before they are set, so really this is just a convenience method for
6060 * <pre>
6061 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6062 * </pre>
6063 *
6064 * @param data The Uri of the data this intent is now targeting.
6065 * @param type The MIME type of the data being handled by this intent.
6066 *
6067 * @return Returns the same Intent object, for chaining multiple calls
6068 * into a single statement.
6069 *
6070 * @see #setType
6071 * @see #setData
6072 * @see #setDataAndType
6073 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006074 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006075 */
6076 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006077 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006078 }
6079
6080 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006082 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006083 * activities that provide <em>all</em> of the requested categories will be
6084 * used.
6085 *
6086 * @param category The desired category. This can be either one of the
6087 * predefined Intent categories, or a custom category in your own
6088 * namespace.
6089 *
6090 * @return Returns the same Intent object, for chaining multiple calls
6091 * into a single statement.
6092 *
6093 * @see #hasCategory
6094 * @see #removeCategory
6095 */
6096 public Intent addCategory(String category) {
6097 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006098 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006099 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006100 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006101 return this;
6102 }
6103
6104 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006105 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006106 *
6107 * @param category The category to remove.
6108 *
6109 * @see #addCategory
6110 */
6111 public void removeCategory(String category) {
6112 if (mCategories != null) {
6113 mCategories.remove(category);
6114 if (mCategories.size() == 0) {
6115 mCategories = null;
6116 }
6117 }
6118 }
6119
6120 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006121 * Set a selector for this Intent. This is a modification to the kinds of
6122 * things the Intent will match. If the selector is set, it will be used
6123 * when trying to find entities that can handle the Intent, instead of the
6124 * main contents of the Intent. This allows you build an Intent containing
6125 * a generic protocol while targeting it more specifically.
6126 *
6127 * <p>An example of where this may be used is with things like
6128 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6129 * Intent that will launch the Browser application. However, the correct
6130 * main entry point of an application is actually {@link #ACTION_MAIN}
6131 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6132 * used to specify the actual Activity to launch. If you launch the browser
6133 * with something different, undesired behavior may happen if the user has
6134 * previously or later launches it the normal way, since they do not match.
6135 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6136 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6137 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6138 *
6139 * <p>Setting a selector does not impact the behavior of
6140 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6141 * desired behavior of a selector -- it does not impact the base meaning
6142 * of the Intent, just what kinds of things will be matched against it
6143 * when determining who can handle it.</p>
6144 *
6145 * <p>You can not use both a selector and {@link #setPackage(String)} on
6146 * the same base Intent.</p>
6147 *
6148 * @param selector The desired selector Intent; set to null to not use
6149 * a special selector.
6150 */
6151 public void setSelector(Intent selector) {
6152 if (selector == this) {
6153 throw new IllegalArgumentException(
6154 "Intent being set as a selector of itself");
6155 }
6156 if (selector != null && mPackage != null) {
6157 throw new IllegalArgumentException(
6158 "Can't set selector when package name is already set");
6159 }
6160 mSelector = selector;
6161 }
6162
6163 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006164 * Set a {@link ClipData} associated with this Intent. This replaces any
6165 * previously set ClipData.
6166 *
6167 * <p>The ClipData in an intent is not used for Intent matching or other
6168 * such operations. Semantically it is like extras, used to transmit
6169 * additional data with the Intent. The main feature of using this over
6170 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
6171 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
6172 * items included in the clip data. This is useful, in particular, if
6173 * you want to transmit an Intent containing multiple <code>content:</code>
6174 * URIs for which the recipient may not have global permission to access the
6175 * content provider.
6176 *
6177 * <p>If the ClipData contains items that are themselves Intents, any
6178 * grant flags in those Intents will be ignored. Only the top-level flags
6179 * of the main Intent are respected, and will be applied to all Uri or
6180 * Intent items in the clip (or sub-items of the clip).
6181 *
6182 * <p>The MIME type, label, and icon in the ClipData object are not
6183 * directly used by Intent. Applications should generally rely on the
6184 * MIME type of the Intent itself, not what it may find in the ClipData.
6185 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05006186 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006187 *
6188 * @param clip The new clip to set. May be null to clear the current clip.
6189 */
6190 public void setClipData(ClipData clip) {
6191 mClipData = clip;
6192 }
6193
6194 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006195 * This is NOT a secure mechanism to identify the user who sent the intent.
6196 * When the intent is sent to a different user, it is used to fix uris by adding the userId
6197 * who sent the intent.
6198 * @hide
6199 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01006200 public void prepareToLeaveUser(int userId) {
6201 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
6202 // We want mContentUserHint to refer to the original user, so don't do anything.
6203 if (mContentUserHint == UserHandle.USER_CURRENT) {
6204 mContentUserHint = userId;
6205 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006206 }
6207
6208 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006209 * Add extended data to the intent. The name must include a package
6210 * prefix, for example the app com.android.contacts would use names
6211 * like "com.android.contacts.ShowAll".
6212 *
6213 * @param name The name of the extra data, with package prefix.
6214 * @param value The boolean data value.
6215 *
6216 * @return Returns the same Intent object, for chaining multiple calls
6217 * into a single statement.
6218 *
6219 * @see #putExtras
6220 * @see #removeExtra
6221 * @see #getBooleanExtra(String, boolean)
6222 */
6223 public Intent putExtra(String name, boolean value) {
6224 if (mExtras == null) {
6225 mExtras = new Bundle();
6226 }
6227 mExtras.putBoolean(name, value);
6228 return this;
6229 }
6230
6231 /**
6232 * Add extended data to the intent. The name must include a package
6233 * prefix, for example the app com.android.contacts would use names
6234 * like "com.android.contacts.ShowAll".
6235 *
6236 * @param name The name of the extra data, with package prefix.
6237 * @param value The byte data value.
6238 *
6239 * @return Returns the same Intent object, for chaining multiple calls
6240 * into a single statement.
6241 *
6242 * @see #putExtras
6243 * @see #removeExtra
6244 * @see #getByteExtra(String, byte)
6245 */
6246 public Intent putExtra(String name, byte value) {
6247 if (mExtras == null) {
6248 mExtras = new Bundle();
6249 }
6250 mExtras.putByte(name, value);
6251 return this;
6252 }
6253
6254 /**
6255 * Add extended data to the intent. The name must include a package
6256 * prefix, for example the app com.android.contacts would use names
6257 * like "com.android.contacts.ShowAll".
6258 *
6259 * @param name The name of the extra data, with package prefix.
6260 * @param value The char data value.
6261 *
6262 * @return Returns the same Intent object, for chaining multiple calls
6263 * into a single statement.
6264 *
6265 * @see #putExtras
6266 * @see #removeExtra
6267 * @see #getCharExtra(String, char)
6268 */
6269 public Intent putExtra(String name, char value) {
6270 if (mExtras == null) {
6271 mExtras = new Bundle();
6272 }
6273 mExtras.putChar(name, value);
6274 return this;
6275 }
6276
6277 /**
6278 * Add extended data to the intent. The name must include a package
6279 * prefix, for example the app com.android.contacts would use names
6280 * like "com.android.contacts.ShowAll".
6281 *
6282 * @param name The name of the extra data, with package prefix.
6283 * @param value The short data value.
6284 *
6285 * @return Returns the same Intent object, for chaining multiple calls
6286 * into a single statement.
6287 *
6288 * @see #putExtras
6289 * @see #removeExtra
6290 * @see #getShortExtra(String, short)
6291 */
6292 public Intent putExtra(String name, short value) {
6293 if (mExtras == null) {
6294 mExtras = new Bundle();
6295 }
6296 mExtras.putShort(name, value);
6297 return this;
6298 }
6299
6300 /**
6301 * Add extended data to the intent. The name must include a package
6302 * prefix, for example the app com.android.contacts would use names
6303 * like "com.android.contacts.ShowAll".
6304 *
6305 * @param name The name of the extra data, with package prefix.
6306 * @param value The integer data value.
6307 *
6308 * @return Returns the same Intent object, for chaining multiple calls
6309 * into a single statement.
6310 *
6311 * @see #putExtras
6312 * @see #removeExtra
6313 * @see #getIntExtra(String, int)
6314 */
6315 public Intent putExtra(String name, int value) {
6316 if (mExtras == null) {
6317 mExtras = new Bundle();
6318 }
6319 mExtras.putInt(name, value);
6320 return this;
6321 }
6322
6323 /**
6324 * Add extended data to the intent. The name must include a package
6325 * prefix, for example the app com.android.contacts would use names
6326 * like "com.android.contacts.ShowAll".
6327 *
6328 * @param name The name of the extra data, with package prefix.
6329 * @param value The long data value.
6330 *
6331 * @return Returns the same Intent object, for chaining multiple calls
6332 * into a single statement.
6333 *
6334 * @see #putExtras
6335 * @see #removeExtra
6336 * @see #getLongExtra(String, long)
6337 */
6338 public Intent putExtra(String name, long value) {
6339 if (mExtras == null) {
6340 mExtras = new Bundle();
6341 }
6342 mExtras.putLong(name, value);
6343 return this;
6344 }
6345
6346 /**
6347 * Add extended data to the intent. The name must include a package
6348 * prefix, for example the app com.android.contacts would use names
6349 * like "com.android.contacts.ShowAll".
6350 *
6351 * @param name The name of the extra data, with package prefix.
6352 * @param value The float data value.
6353 *
6354 * @return Returns the same Intent object, for chaining multiple calls
6355 * into a single statement.
6356 *
6357 * @see #putExtras
6358 * @see #removeExtra
6359 * @see #getFloatExtra(String, float)
6360 */
6361 public Intent putExtra(String name, float value) {
6362 if (mExtras == null) {
6363 mExtras = new Bundle();
6364 }
6365 mExtras.putFloat(name, value);
6366 return this;
6367 }
6368
6369 /**
6370 * Add extended data to the intent. The name must include a package
6371 * prefix, for example the app com.android.contacts would use names
6372 * like "com.android.contacts.ShowAll".
6373 *
6374 * @param name The name of the extra data, with package prefix.
6375 * @param value The double data value.
6376 *
6377 * @return Returns the same Intent object, for chaining multiple calls
6378 * into a single statement.
6379 *
6380 * @see #putExtras
6381 * @see #removeExtra
6382 * @see #getDoubleExtra(String, double)
6383 */
6384 public Intent putExtra(String name, double value) {
6385 if (mExtras == null) {
6386 mExtras = new Bundle();
6387 }
6388 mExtras.putDouble(name, value);
6389 return this;
6390 }
6391
6392 /**
6393 * Add extended data to the intent. The name must include a package
6394 * prefix, for example the app com.android.contacts would use names
6395 * like "com.android.contacts.ShowAll".
6396 *
6397 * @param name The name of the extra data, with package prefix.
6398 * @param value The String data value.
6399 *
6400 * @return Returns the same Intent object, for chaining multiple calls
6401 * into a single statement.
6402 *
6403 * @see #putExtras
6404 * @see #removeExtra
6405 * @see #getStringExtra(String)
6406 */
6407 public Intent putExtra(String name, String value) {
6408 if (mExtras == null) {
6409 mExtras = new Bundle();
6410 }
6411 mExtras.putString(name, value);
6412 return this;
6413 }
6414
6415 /**
6416 * Add extended data to the intent. The name must include a package
6417 * prefix, for example the app com.android.contacts would use names
6418 * like "com.android.contacts.ShowAll".
6419 *
6420 * @param name The name of the extra data, with package prefix.
6421 * @param value The CharSequence data value.
6422 *
6423 * @return Returns the same Intent object, for chaining multiple calls
6424 * into a single statement.
6425 *
6426 * @see #putExtras
6427 * @see #removeExtra
6428 * @see #getCharSequenceExtra(String)
6429 */
6430 public Intent putExtra(String name, CharSequence value) {
6431 if (mExtras == null) {
6432 mExtras = new Bundle();
6433 }
6434 mExtras.putCharSequence(name, value);
6435 return this;
6436 }
6437
6438 /**
6439 * Add extended data to the intent. The name must include a package
6440 * prefix, for example the app com.android.contacts would use names
6441 * like "com.android.contacts.ShowAll".
6442 *
6443 * @param name The name of the extra data, with package prefix.
6444 * @param value The Parcelable data value.
6445 *
6446 * @return Returns the same Intent object, for chaining multiple calls
6447 * into a single statement.
6448 *
6449 * @see #putExtras
6450 * @see #removeExtra
6451 * @see #getParcelableExtra(String)
6452 */
6453 public Intent putExtra(String name, Parcelable value) {
6454 if (mExtras == null) {
6455 mExtras = new Bundle();
6456 }
6457 mExtras.putParcelable(name, value);
6458 return this;
6459 }
6460
6461 /**
6462 * Add extended data to the intent. The name must include a package
6463 * prefix, for example the app com.android.contacts would use names
6464 * like "com.android.contacts.ShowAll".
6465 *
6466 * @param name The name of the extra data, with package prefix.
6467 * @param value The Parcelable[] data value.
6468 *
6469 * @return Returns the same Intent object, for chaining multiple calls
6470 * into a single statement.
6471 *
6472 * @see #putExtras
6473 * @see #removeExtra
6474 * @see #getParcelableArrayExtra(String)
6475 */
6476 public Intent putExtra(String name, Parcelable[] value) {
6477 if (mExtras == null) {
6478 mExtras = new Bundle();
6479 }
6480 mExtras.putParcelableArray(name, value);
6481 return this;
6482 }
6483
6484 /**
6485 * Add extended data to the intent. The name must include a package
6486 * prefix, for example the app com.android.contacts would use names
6487 * like "com.android.contacts.ShowAll".
6488 *
6489 * @param name The name of the extra data, with package prefix.
6490 * @param value The ArrayList<Parcelable> data value.
6491 *
6492 * @return Returns the same Intent object, for chaining multiple calls
6493 * into a single statement.
6494 *
6495 * @see #putExtras
6496 * @see #removeExtra
6497 * @see #getParcelableArrayListExtra(String)
6498 */
6499 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6500 if (mExtras == null) {
6501 mExtras = new Bundle();
6502 }
6503 mExtras.putParcelableArrayList(name, value);
6504 return this;
6505 }
6506
6507 /**
6508 * Add extended data to the intent. The name must include a package
6509 * prefix, for example the app com.android.contacts would use names
6510 * like "com.android.contacts.ShowAll".
6511 *
6512 * @param name The name of the extra data, with package prefix.
6513 * @param value The ArrayList<Integer> data value.
6514 *
6515 * @return Returns the same Intent object, for chaining multiple calls
6516 * into a single statement.
6517 *
6518 * @see #putExtras
6519 * @see #removeExtra
6520 * @see #getIntegerArrayListExtra(String)
6521 */
6522 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6523 if (mExtras == null) {
6524 mExtras = new Bundle();
6525 }
6526 mExtras.putIntegerArrayList(name, value);
6527 return this;
6528 }
6529
6530 /**
6531 * Add extended data to the intent. The name must include a package
6532 * prefix, for example the app com.android.contacts would use names
6533 * like "com.android.contacts.ShowAll".
6534 *
6535 * @param name The name of the extra data, with package prefix.
6536 * @param value The ArrayList<String> data value.
6537 *
6538 * @return Returns the same Intent object, for chaining multiple calls
6539 * into a single statement.
6540 *
6541 * @see #putExtras
6542 * @see #removeExtra
6543 * @see #getStringArrayListExtra(String)
6544 */
6545 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6546 if (mExtras == null) {
6547 mExtras = new Bundle();
6548 }
6549 mExtras.putStringArrayList(name, value);
6550 return this;
6551 }
6552
6553 /**
6554 * Add extended data to the intent. The name must include a package
6555 * prefix, for example the app com.android.contacts would use names
6556 * like "com.android.contacts.ShowAll".
6557 *
6558 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006559 * @param value The ArrayList<CharSequence> data value.
6560 *
6561 * @return Returns the same Intent object, for chaining multiple calls
6562 * into a single statement.
6563 *
6564 * @see #putExtras
6565 * @see #removeExtra
6566 * @see #getCharSequenceArrayListExtra(String)
6567 */
6568 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6569 if (mExtras == null) {
6570 mExtras = new Bundle();
6571 }
6572 mExtras.putCharSequenceArrayList(name, value);
6573 return this;
6574 }
6575
6576 /**
6577 * Add extended data to the intent. The name must include a package
6578 * prefix, for example the app com.android.contacts would use names
6579 * like "com.android.contacts.ShowAll".
6580 *
6581 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006582 * @param value The Serializable data value.
6583 *
6584 * @return Returns the same Intent object, for chaining multiple calls
6585 * into a single statement.
6586 *
6587 * @see #putExtras
6588 * @see #removeExtra
6589 * @see #getSerializableExtra(String)
6590 */
6591 public Intent putExtra(String name, Serializable value) {
6592 if (mExtras == null) {
6593 mExtras = new Bundle();
6594 }
6595 mExtras.putSerializable(name, value);
6596 return this;
6597 }
6598
6599 /**
6600 * Add extended data to the intent. The name must include a package
6601 * prefix, for example the app com.android.contacts would use names
6602 * like "com.android.contacts.ShowAll".
6603 *
6604 * @param name The name of the extra data, with package prefix.
6605 * @param value The boolean array data value.
6606 *
6607 * @return Returns the same Intent object, for chaining multiple calls
6608 * into a single statement.
6609 *
6610 * @see #putExtras
6611 * @see #removeExtra
6612 * @see #getBooleanArrayExtra(String)
6613 */
6614 public Intent putExtra(String name, boolean[] value) {
6615 if (mExtras == null) {
6616 mExtras = new Bundle();
6617 }
6618 mExtras.putBooleanArray(name, value);
6619 return this;
6620 }
6621
6622 /**
6623 * Add extended data to the intent. The name must include a package
6624 * prefix, for example the app com.android.contacts would use names
6625 * like "com.android.contacts.ShowAll".
6626 *
6627 * @param name The name of the extra data, with package prefix.
6628 * @param value The byte array data value.
6629 *
6630 * @return Returns the same Intent object, for chaining multiple calls
6631 * into a single statement.
6632 *
6633 * @see #putExtras
6634 * @see #removeExtra
6635 * @see #getByteArrayExtra(String)
6636 */
6637 public Intent putExtra(String name, byte[] value) {
6638 if (mExtras == null) {
6639 mExtras = new Bundle();
6640 }
6641 mExtras.putByteArray(name, value);
6642 return this;
6643 }
6644
6645 /**
6646 * Add extended data to the intent. The name must include a package
6647 * prefix, for example the app com.android.contacts would use names
6648 * like "com.android.contacts.ShowAll".
6649 *
6650 * @param name The name of the extra data, with package prefix.
6651 * @param value The short array data value.
6652 *
6653 * @return Returns the same Intent object, for chaining multiple calls
6654 * into a single statement.
6655 *
6656 * @see #putExtras
6657 * @see #removeExtra
6658 * @see #getShortArrayExtra(String)
6659 */
6660 public Intent putExtra(String name, short[] value) {
6661 if (mExtras == null) {
6662 mExtras = new Bundle();
6663 }
6664 mExtras.putShortArray(name, value);
6665 return this;
6666 }
6667
6668 /**
6669 * Add extended data to the intent. The name must include a package
6670 * prefix, for example the app com.android.contacts would use names
6671 * like "com.android.contacts.ShowAll".
6672 *
6673 * @param name The name of the extra data, with package prefix.
6674 * @param value The char array data value.
6675 *
6676 * @return Returns the same Intent object, for chaining multiple calls
6677 * into a single statement.
6678 *
6679 * @see #putExtras
6680 * @see #removeExtra
6681 * @see #getCharArrayExtra(String)
6682 */
6683 public Intent putExtra(String name, char[] value) {
6684 if (mExtras == null) {
6685 mExtras = new Bundle();
6686 }
6687 mExtras.putCharArray(name, value);
6688 return this;
6689 }
6690
6691 /**
6692 * Add extended data to the intent. The name must include a package
6693 * prefix, for example the app com.android.contacts would use names
6694 * like "com.android.contacts.ShowAll".
6695 *
6696 * @param name The name of the extra data, with package prefix.
6697 * @param value The int array data value.
6698 *
6699 * @return Returns the same Intent object, for chaining multiple calls
6700 * into a single statement.
6701 *
6702 * @see #putExtras
6703 * @see #removeExtra
6704 * @see #getIntArrayExtra(String)
6705 */
6706 public Intent putExtra(String name, int[] value) {
6707 if (mExtras == null) {
6708 mExtras = new Bundle();
6709 }
6710 mExtras.putIntArray(name, value);
6711 return this;
6712 }
6713
6714 /**
6715 * Add extended data to the intent. The name must include a package
6716 * prefix, for example the app com.android.contacts would use names
6717 * like "com.android.contacts.ShowAll".
6718 *
6719 * @param name The name of the extra data, with package prefix.
6720 * @param value The byte array data value.
6721 *
6722 * @return Returns the same Intent object, for chaining multiple calls
6723 * into a single statement.
6724 *
6725 * @see #putExtras
6726 * @see #removeExtra
6727 * @see #getLongArrayExtra(String)
6728 */
6729 public Intent putExtra(String name, long[] value) {
6730 if (mExtras == null) {
6731 mExtras = new Bundle();
6732 }
6733 mExtras.putLongArray(name, value);
6734 return this;
6735 }
6736
6737 /**
6738 * Add extended data to the intent. The name must include a package
6739 * prefix, for example the app com.android.contacts would use names
6740 * like "com.android.contacts.ShowAll".
6741 *
6742 * @param name The name of the extra data, with package prefix.
6743 * @param value The float array data value.
6744 *
6745 * @return Returns the same Intent object, for chaining multiple calls
6746 * into a single statement.
6747 *
6748 * @see #putExtras
6749 * @see #removeExtra
6750 * @see #getFloatArrayExtra(String)
6751 */
6752 public Intent putExtra(String name, float[] value) {
6753 if (mExtras == null) {
6754 mExtras = new Bundle();
6755 }
6756 mExtras.putFloatArray(name, value);
6757 return this;
6758 }
6759
6760 /**
6761 * Add extended data to the intent. The name must include a package
6762 * prefix, for example the app com.android.contacts would use names
6763 * like "com.android.contacts.ShowAll".
6764 *
6765 * @param name The name of the extra data, with package prefix.
6766 * @param value The double array data value.
6767 *
6768 * @return Returns the same Intent object, for chaining multiple calls
6769 * into a single statement.
6770 *
6771 * @see #putExtras
6772 * @see #removeExtra
6773 * @see #getDoubleArrayExtra(String)
6774 */
6775 public Intent putExtra(String name, double[] value) {
6776 if (mExtras == null) {
6777 mExtras = new Bundle();
6778 }
6779 mExtras.putDoubleArray(name, value);
6780 return this;
6781 }
6782
6783 /**
6784 * Add extended data to the intent. The name must include a package
6785 * prefix, for example the app com.android.contacts would use names
6786 * like "com.android.contacts.ShowAll".
6787 *
6788 * @param name The name of the extra data, with package prefix.
6789 * @param value The String array data value.
6790 *
6791 * @return Returns the same Intent object, for chaining multiple calls
6792 * into a single statement.
6793 *
6794 * @see #putExtras
6795 * @see #removeExtra
6796 * @see #getStringArrayExtra(String)
6797 */
6798 public Intent putExtra(String name, String[] value) {
6799 if (mExtras == null) {
6800 mExtras = new Bundle();
6801 }
6802 mExtras.putStringArray(name, value);
6803 return this;
6804 }
6805
6806 /**
6807 * Add extended data to the intent. The name must include a package
6808 * prefix, for example the app com.android.contacts would use names
6809 * like "com.android.contacts.ShowAll".
6810 *
6811 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006812 * @param value The CharSequence array data value.
6813 *
6814 * @return Returns the same Intent object, for chaining multiple calls
6815 * into a single statement.
6816 *
6817 * @see #putExtras
6818 * @see #removeExtra
6819 * @see #getCharSequenceArrayExtra(String)
6820 */
6821 public Intent putExtra(String name, CharSequence[] value) {
6822 if (mExtras == null) {
6823 mExtras = new Bundle();
6824 }
6825 mExtras.putCharSequenceArray(name, value);
6826 return this;
6827 }
6828
6829 /**
6830 * Add extended data to the intent. The name must include a package
6831 * prefix, for example the app com.android.contacts would use names
6832 * like "com.android.contacts.ShowAll".
6833 *
6834 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006835 * @param value The Bundle data value.
6836 *
6837 * @return Returns the same Intent object, for chaining multiple calls
6838 * into a single statement.
6839 *
6840 * @see #putExtras
6841 * @see #removeExtra
6842 * @see #getBundleExtra(String)
6843 */
6844 public Intent putExtra(String name, Bundle value) {
6845 if (mExtras == null) {
6846 mExtras = new Bundle();
6847 }
6848 mExtras.putBundle(name, value);
6849 return this;
6850 }
6851
6852 /**
6853 * Add extended data to the intent. The name must include a package
6854 * prefix, for example the app com.android.contacts would use names
6855 * like "com.android.contacts.ShowAll".
6856 *
6857 * @param name The name of the extra data, with package prefix.
6858 * @param value The IBinder data value.
6859 *
6860 * @return Returns the same Intent object, for chaining multiple calls
6861 * into a single statement.
6862 *
6863 * @see #putExtras
6864 * @see #removeExtra
6865 * @see #getIBinderExtra(String)
6866 *
6867 * @deprecated
6868 * @hide
6869 */
6870 @Deprecated
6871 public Intent putExtra(String name, IBinder value) {
6872 if (mExtras == null) {
6873 mExtras = new Bundle();
6874 }
6875 mExtras.putIBinder(name, value);
6876 return this;
6877 }
6878
6879 /**
6880 * Copy all extras in 'src' in to this intent.
6881 *
6882 * @param src Contains the extras to copy.
6883 *
6884 * @see #putExtra
6885 */
6886 public Intent putExtras(Intent src) {
6887 if (src.mExtras != null) {
6888 if (mExtras == null) {
6889 mExtras = new Bundle(src.mExtras);
6890 } else {
6891 mExtras.putAll(src.mExtras);
6892 }
6893 }
6894 return this;
6895 }
6896
6897 /**
6898 * Add a set of extended data to the intent. The keys must include a package
6899 * prefix, for example the app com.android.contacts would use names
6900 * like "com.android.contacts.ShowAll".
6901 *
6902 * @param extras The Bundle of extras to add to this intent.
6903 *
6904 * @see #putExtra
6905 * @see #removeExtra
6906 */
6907 public Intent putExtras(Bundle extras) {
6908 if (mExtras == null) {
6909 mExtras = new Bundle();
6910 }
6911 mExtras.putAll(extras);
6912 return this;
6913 }
6914
6915 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006916 * Completely replace the extras in the Intent with the extras in the
6917 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006918 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006919 * @param src The exact extras contained in this Intent are copied
6920 * into the target intent, replacing any that were previously there.
6921 */
6922 public Intent replaceExtras(Intent src) {
6923 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6924 return this;
6925 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006926
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006927 /**
6928 * Completely replace the extras in the Intent with the given Bundle of
6929 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006930 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006931 * @param extras The new set of extras in the Intent, or null to erase
6932 * all extras.
6933 */
6934 public Intent replaceExtras(Bundle extras) {
6935 mExtras = extras != null ? new Bundle(extras) : null;
6936 return this;
6937 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006938
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006939 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006940 * Remove extended data from the intent.
6941 *
6942 * @see #putExtra
6943 */
6944 public void removeExtra(String name) {
6945 if (mExtras != null) {
6946 mExtras.remove(name);
6947 if (mExtras.size() == 0) {
6948 mExtras = null;
6949 }
6950 }
6951 }
6952
6953 /**
6954 * Set special flags controlling how this intent is handled. Most values
6955 * here depend on the type of component being executed by the Intent,
6956 * specifically the FLAG_ACTIVITY_* flags are all for use with
6957 * {@link Context#startActivity Context.startActivity()} and the
6958 * FLAG_RECEIVER_* flags are all for use with
6959 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6960 *
Scott Main7aee61f2011-02-08 11:25:01 -08006961 * <p>See the
6962 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6963 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006964 * the behavior of your application.
6965 *
6966 * @param flags The desired flags.
6967 *
6968 * @return Returns the same Intent object, for chaining multiple calls
6969 * into a single statement.
6970 *
6971 * @see #getFlags
6972 * @see #addFlags
6973 *
6974 * @see #FLAG_GRANT_READ_URI_PERMISSION
6975 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006976 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6977 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006978 * @see #FLAG_DEBUG_LOG_RESOLUTION
6979 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006980 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006981 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006982 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006983 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006984 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6985 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006986 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006987 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006988 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006989 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006990 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006991 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006992 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006993 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6994 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006995 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006996 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006997 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006998 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6999 */
7000 public Intent setFlags(int flags) {
7001 mFlags = flags;
7002 return this;
7003 }
7004
7005 /**
7006 * Add additional flags to the intent (or with existing flags
7007 * value).
7008 *
7009 * @param flags The new flags to set.
7010 *
7011 * @return Returns the same Intent object, for chaining multiple calls
7012 * into a single statement.
7013 *
7014 * @see #setFlags
7015 */
7016 public Intent addFlags(int flags) {
7017 mFlags |= flags;
7018 return this;
7019 }
7020
7021 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007022 * (Usually optional) Set an explicit application package name that limits
7023 * the components this Intent will resolve to. If left to the default
7024 * value of null, all components in all applications will considered.
7025 * If non-null, the Intent can only match the components in the given
7026 * application package.
7027 *
7028 * @param packageName The name of the application package to handle the
7029 * intent, or null to allow any application package.
7030 *
7031 * @return Returns the same Intent object, for chaining multiple calls
7032 * into a single statement.
7033 *
7034 * @see #getPackage
7035 * @see #resolveActivity
7036 */
7037 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007038 if (packageName != null && mSelector != null) {
7039 throw new IllegalArgumentException(
7040 "Can't set package name when selector is already set");
7041 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007042 mPackage = packageName;
7043 return this;
7044 }
7045
7046 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007047 * (Usually optional) Explicitly set the component to handle the intent.
7048 * If left with the default value of null, the system will determine the
7049 * appropriate class to use based on the other fields (action, data,
7050 * type, categories) in the Intent. If this class is defined, the
7051 * specified class will always be used regardless of the other fields. You
7052 * should only set this value when you know you absolutely want a specific
7053 * class to be used; otherwise it is better to let the system find the
7054 * appropriate class so that you will respect the installed applications
7055 * and user preferences.
7056 *
7057 * @param component The name of the application component to handle the
7058 * intent, or null to let the system find one for you.
7059 *
7060 * @return Returns the same Intent object, for chaining multiple calls
7061 * into a single statement.
7062 *
7063 * @see #setClass
7064 * @see #setClassName(Context, String)
7065 * @see #setClassName(String, String)
7066 * @see #getComponent
7067 * @see #resolveActivity
7068 */
7069 public Intent setComponent(ComponentName component) {
7070 mComponent = component;
7071 return this;
7072 }
7073
7074 /**
7075 * Convenience for calling {@link #setComponent} with an
7076 * explicit class name.
7077 *
7078 * @param packageContext A Context of the application package implementing
7079 * this class.
7080 * @param className The name of a class inside of the application package
7081 * that will be used as the component for this Intent.
7082 *
7083 * @return Returns the same Intent object, for chaining multiple calls
7084 * into a single statement.
7085 *
7086 * @see #setComponent
7087 * @see #setClass
7088 */
7089 public Intent setClassName(Context packageContext, String className) {
7090 mComponent = new ComponentName(packageContext, className);
7091 return this;
7092 }
7093
7094 /**
7095 * Convenience for calling {@link #setComponent} with an
7096 * explicit application package name and class name.
7097 *
7098 * @param packageName The name of the package implementing the desired
7099 * component.
7100 * @param className The name of a class inside of the application package
7101 * that will be used as the component for this Intent.
7102 *
7103 * @return Returns the same Intent object, for chaining multiple calls
7104 * into a single statement.
7105 *
7106 * @see #setComponent
7107 * @see #setClass
7108 */
7109 public Intent setClassName(String packageName, String className) {
7110 mComponent = new ComponentName(packageName, className);
7111 return this;
7112 }
7113
7114 /**
7115 * Convenience for calling {@link #setComponent(ComponentName)} with the
7116 * name returned by a {@link Class} object.
7117 *
7118 * @param packageContext A Context of the application package implementing
7119 * this class.
7120 * @param cls The class name to set, equivalent to
7121 * <code>setClassName(context, cls.getName())</code>.
7122 *
7123 * @return Returns the same Intent object, for chaining multiple calls
7124 * into a single statement.
7125 *
7126 * @see #setComponent
7127 */
7128 public Intent setClass(Context packageContext, Class<?> cls) {
7129 mComponent = new ComponentName(packageContext, cls);
7130 return this;
7131 }
7132
7133 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007134 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7135 * used as a hint to the receiver for animations and the like. Null means that there
7136 * is no source bounds.
7137 */
7138 public void setSourceBounds(Rect r) {
7139 if (r != null) {
7140 mSourceBounds = new Rect(r);
7141 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007142 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007143 }
7144 }
7145
Tor Norbyed9273d62013-05-30 15:59:53 -07007146 /** @hide */
7147 @IntDef(flag = true,
7148 value = {
7149 FILL_IN_ACTION,
7150 FILL_IN_DATA,
7151 FILL_IN_CATEGORIES,
7152 FILL_IN_COMPONENT,
7153 FILL_IN_PACKAGE,
7154 FILL_IN_SOURCE_BOUNDS,
7155 FILL_IN_SELECTOR,
7156 FILL_IN_CLIP_DATA
7157 })
7158 @Retention(RetentionPolicy.SOURCE)
7159 public @interface FillInFlags {}
7160
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007161 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007162 * Use with {@link #fillIn} to allow the current action value to be
7163 * overwritten, even if it is already set.
7164 */
7165 public static final int FILL_IN_ACTION = 1<<0;
7166
7167 /**
7168 * Use with {@link #fillIn} to allow the current data or type value
7169 * overwritten, even if it is already set.
7170 */
7171 public static final int FILL_IN_DATA = 1<<1;
7172
7173 /**
7174 * Use with {@link #fillIn} to allow the current categories to be
7175 * overwritten, even if they are already set.
7176 */
7177 public static final int FILL_IN_CATEGORIES = 1<<2;
7178
7179 /**
7180 * Use with {@link #fillIn} to allow the current component value to be
7181 * overwritten, even if it is already set.
7182 */
7183 public static final int FILL_IN_COMPONENT = 1<<3;
7184
7185 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007186 * Use with {@link #fillIn} to allow the current package value to be
7187 * overwritten, even if it is already set.
7188 */
7189 public static final int FILL_IN_PACKAGE = 1<<4;
7190
7191 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007192 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007193 * overwritten, even if it is already set.
7194 */
7195 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
7196
7197 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007198 * Use with {@link #fillIn} to allow the current selector to be
7199 * overwritten, even if it is already set.
7200 */
7201 public static final int FILL_IN_SELECTOR = 1<<6;
7202
7203 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007204 * Use with {@link #fillIn} to allow the current ClipData to be
7205 * overwritten, even if it is already set.
7206 */
7207 public static final int FILL_IN_CLIP_DATA = 1<<7;
7208
7209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007210 * Copy the contents of <var>other</var> in to this object, but only
7211 * where fields are not defined by this object. For purposes of a field
7212 * being defined, the following pieces of data in the Intent are
7213 * considered to be separate fields:
7214 *
7215 * <ul>
7216 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08007217 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007218 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
7219 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007220 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007221 * <li> component, as set by {@link #setComponent(ComponentName)} or
7222 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007223 * <li> source bounds, as set by {@link #setSourceBounds}.
7224 * <li> selector, as set by {@link #setSelector(Intent)}.
7225 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007226 * <li> each top-level name in the associated extras.
7227 * </ul>
7228 *
7229 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007230 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007231 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7232 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
7233 * the restriction where the corresponding field will not be replaced if
7234 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007235 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007236 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
7237 * is explicitly specified. The selector will only be copied if
7238 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07007239 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007240 * <p>For example, consider Intent A with {data="foo", categories="bar"}
7241 * and Intent B with {action="gotit", data-type="some/thing",
7242 * categories="one","two"}.
7243 *
7244 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
7245 * containing: {action="gotit", data-type="some/thing",
7246 * categories="bar"}.
7247 *
7248 * @param other Another Intent whose values are to be used to fill in
7249 * the current one.
7250 * @param flags Options to control which fields can be filled in.
7251 *
7252 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007253 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07007254 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7255 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
7256 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007257 */
Tor Norbyed9273d62013-05-30 15:59:53 -07007258 @FillInFlags
7259 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007260 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007261 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007262 if (other.mAction != null
7263 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007264 mAction = other.mAction;
7265 changes |= FILL_IN_ACTION;
7266 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007267 if ((other.mData != null || other.mType != null)
7268 && ((mData == null && mType == null)
7269 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007270 mData = other.mData;
7271 mType = other.mType;
7272 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007273 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007274 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007275 if (other.mCategories != null
7276 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007277 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007278 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007279 }
7280 changes |= FILL_IN_CATEGORIES;
7281 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007282 if (other.mPackage != null
7283 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007284 // Only do this if mSelector is not set.
7285 if (mSelector == null) {
7286 mPackage = other.mPackage;
7287 changes |= FILL_IN_PACKAGE;
7288 }
7289 }
7290 // Selector is special: it can only be set if explicitly allowed,
7291 // for the same reason as the component name.
7292 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
7293 if (mPackage == null) {
7294 mSelector = new Intent(other.mSelector);
7295 mPackage = null;
7296 changes |= FILL_IN_SELECTOR;
7297 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007298 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007299 if (other.mClipData != null
7300 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
7301 mClipData = other.mClipData;
7302 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007303 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007304 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007305 // Component is special: it can -only- be set if explicitly allowed,
7306 // since otherwise the sender could force the intent somewhere the
7307 // originator didn't intend.
7308 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007309 mComponent = other.mComponent;
7310 changes |= FILL_IN_COMPONENT;
7311 }
7312 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007313 if (other.mSourceBounds != null
7314 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
7315 mSourceBounds = new Rect(other.mSourceBounds);
7316 changes |= FILL_IN_SOURCE_BOUNDS;
7317 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007318 if (mExtras == null) {
7319 if (other.mExtras != null) {
7320 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007321 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007322 }
7323 } else if (other.mExtras != null) {
7324 try {
7325 Bundle newb = new Bundle(other.mExtras);
7326 newb.putAll(mExtras);
7327 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007328 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007329 } catch (RuntimeException e) {
7330 // Modifying the extras can cause us to unparcel the contents
7331 // of the bundle, and if we do this in the system process that
7332 // may fail. We really should handle this (i.e., the Bundle
7333 // impl shouldn't be on top of a plain map), but for now just
7334 // ignore it and keep the original contents. :(
7335 Log.w("Intent", "Failure filling in extras", e);
7336 }
7337 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007338 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
7339 && other.mContentUserHint != UserHandle.USER_CURRENT) {
7340 mContentUserHint = other.mContentUserHint;
7341 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007342 return changes;
7343 }
7344
7345 /**
7346 * Wrapper class holding an Intent and implementing comparisons on it for
7347 * the purpose of filtering. The class implements its
7348 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
7349 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
7350 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
7351 * on the wrapped Intent.
7352 */
7353 public static final class FilterComparison {
7354 private final Intent mIntent;
7355 private final int mHashCode;
7356
7357 public FilterComparison(Intent intent) {
7358 mIntent = intent;
7359 mHashCode = intent.filterHashCode();
7360 }
7361
7362 /**
7363 * Return the Intent that this FilterComparison represents.
7364 * @return Returns the Intent held by the FilterComparison. Do
7365 * not modify!
7366 */
7367 public Intent getIntent() {
7368 return mIntent;
7369 }
7370
7371 @Override
7372 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007373 if (obj instanceof FilterComparison) {
7374 Intent other = ((FilterComparison)obj).mIntent;
7375 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007376 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007377 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007378 }
7379
7380 @Override
7381 public int hashCode() {
7382 return mHashCode;
7383 }
7384 }
7385
7386 /**
7387 * Determine if two intents are the same for the purposes of intent
7388 * resolution (filtering). That is, if their action, data, type,
7389 * class, and categories are the same. This does <em>not</em> compare
7390 * any extra data included in the intents.
7391 *
7392 * @param other The other Intent to compare against.
7393 *
7394 * @return Returns true if action, data, type, class, and categories
7395 * are the same.
7396 */
7397 public boolean filterEquals(Intent other) {
7398 if (other == null) {
7399 return false;
7400 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07007401 if (!Objects.equals(this.mAction, other.mAction)) return false;
7402 if (!Objects.equals(this.mData, other.mData)) return false;
7403 if (!Objects.equals(this.mType, other.mType)) return false;
7404 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
7405 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
7406 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007407
7408 return true;
7409 }
7410
7411 /**
7412 * Generate hash code that matches semantics of filterEquals().
7413 *
7414 * @return Returns the hash value of the action, data, type, class, and
7415 * categories.
7416 *
7417 * @see #filterEquals
7418 */
7419 public int filterHashCode() {
7420 int code = 0;
7421 if (mAction != null) {
7422 code += mAction.hashCode();
7423 }
7424 if (mData != null) {
7425 code += mData.hashCode();
7426 }
7427 if (mType != null) {
7428 code += mType.hashCode();
7429 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007430 if (mPackage != null) {
7431 code += mPackage.hashCode();
7432 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007433 if (mComponent != null) {
7434 code += mComponent.hashCode();
7435 }
7436 if (mCategories != null) {
7437 code += mCategories.hashCode();
7438 }
7439 return code;
7440 }
7441
7442 @Override
7443 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007444 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007445
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007446 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007447 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007448 b.append(" }");
7449
7450 return b.toString();
7451 }
7452
7453 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007454 public String toInsecureString() {
7455 StringBuilder b = new StringBuilder(128);
7456
7457 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007458 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007459 b.append(" }");
7460
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007461 return b.toString();
7462 }
Romain Guy4969af72009-06-17 10:53:19 -07007463
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007464 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007465 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007466 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007467
7468 b.append("Intent { ");
7469 toShortString(b, false, true, true, true);
7470 b.append(" }");
7471
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007472 return b.toString();
7473 }
7474
7475 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007476 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
7477 StringBuilder b = new StringBuilder(128);
7478 toShortString(b, secure, comp, extras, clip);
7479 return b.toString();
7480 }
7481
7482 /** @hide */
7483 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
7484 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007485 boolean first = true;
7486 if (mAction != null) {
7487 b.append("act=").append(mAction);
7488 first = false;
7489 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007490 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007491 if (!first) {
7492 b.append(' ');
7493 }
7494 first = false;
7495 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007496 for (int i=0; i<mCategories.size(); i++) {
7497 if (i > 0) b.append(',');
7498 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007499 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007500 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007501 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007502 if (mData != null) {
7503 if (!first) {
7504 b.append(' ');
7505 }
7506 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007507 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007508 if (secure) {
7509 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007510 } else {
7511 b.append(mData);
7512 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007513 }
7514 if (mType != null) {
7515 if (!first) {
7516 b.append(' ');
7517 }
7518 first = false;
7519 b.append("typ=").append(mType);
7520 }
7521 if (mFlags != 0) {
7522 if (!first) {
7523 b.append(' ');
7524 }
7525 first = false;
7526 b.append("flg=0x").append(Integer.toHexString(mFlags));
7527 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007528 if (mPackage != null) {
7529 if (!first) {
7530 b.append(' ');
7531 }
7532 first = false;
7533 b.append("pkg=").append(mPackage);
7534 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007535 if (comp && mComponent != null) {
7536 if (!first) {
7537 b.append(' ');
7538 }
7539 first = false;
7540 b.append("cmp=").append(mComponent.flattenToShortString());
7541 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007542 if (mSourceBounds != null) {
7543 if (!first) {
7544 b.append(' ');
7545 }
7546 first = false;
7547 b.append("bnds=").append(mSourceBounds.toShortString());
7548 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007549 if (mClipData != null) {
7550 if (!first) {
7551 b.append(' ');
7552 }
7553 first = false;
7554 if (clip) {
7555 b.append("clip={");
7556 mClipData.toShortString(b);
7557 b.append('}');
7558 } else {
7559 b.append("(has clip)");
7560 }
7561 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007562 if (extras && mExtras != null) {
7563 if (!first) {
7564 b.append(' ');
7565 }
7566 first = false;
7567 b.append("(has extras)");
7568 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007569 if (mContentUserHint != UserHandle.USER_CURRENT) {
7570 if (!first) {
7571 b.append(' ');
7572 }
7573 first = false;
7574 b.append("u=").append(mContentUserHint);
7575 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007576 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007577 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007578 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007579 b.append("}");
7580 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007581 }
7582
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007583 /**
7584 * Call {@link #toUri} with 0 flags.
7585 * @deprecated Use {@link #toUri} instead.
7586 */
7587 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007588 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007589 return toUri(0);
7590 }
7591
7592 /**
7593 * Convert this Intent into a String holding a URI representation of it.
7594 * The returned URI string has been properly URI encoded, so it can be
7595 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7596 * Intent's data as the base URI, with an additional fragment describing
7597 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007598 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007599 * <p>You can convert the returned string back to an Intent with
7600 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007601 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007602 * @param flags Additional operating flags. Either 0,
7603 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007604 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007605 * @return Returns a URI encoding URI string describing the entire contents
7606 * of the Intent.
7607 */
7608 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007609 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007610 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
7611 if (mPackage == null) {
7612 throw new IllegalArgumentException(
7613 "Intent must include an explicit package name to build an android-app: "
7614 + this);
7615 }
7616 uri.append("android-app://");
7617 uri.append(mPackage);
7618 String scheme = null;
7619 if (mData != null) {
7620 scheme = mData.getScheme();
7621 if (scheme != null) {
7622 uri.append('/');
7623 uri.append(scheme);
7624 String authority = mData.getEncodedAuthority();
7625 if (authority != null) {
7626 uri.append('/');
7627 uri.append(authority);
7628 String path = mData.getEncodedPath();
7629 if (path != null) {
7630 uri.append(path);
7631 }
7632 String queryParams = mData.getEncodedQuery();
7633 if (queryParams != null) {
7634 uri.append('?');
7635 uri.append(queryParams);
7636 }
7637 String fragment = mData.getEncodedFragment();
7638 if (fragment != null) {
7639 uri.append('#');
7640 uri.append(fragment);
7641 }
7642 }
7643 }
7644 }
7645 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
7646 mPackage, flags);
7647 return uri.toString();
7648 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007649 String scheme = null;
7650 if (mData != null) {
7651 String data = mData.toString();
7652 if ((flags&URI_INTENT_SCHEME) != 0) {
7653 final int N = data.length();
7654 for (int i=0; i<N; i++) {
7655 char c = data.charAt(i);
7656 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7657 || c == '.' || c == '-') {
7658 continue;
7659 }
7660 if (c == ':' && i > 0) {
7661 // Valid scheme.
7662 scheme = data.substring(0, i);
7663 uri.append("intent:");
7664 data = data.substring(i+1);
7665 break;
7666 }
Tom Taylord4a47292009-12-21 13:59:18 -08007667
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007668 // No scheme.
7669 break;
7670 }
7671 }
7672 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007673
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007674 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7675 uri.append("intent:");
7676 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007677
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007678 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007679
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007680 return uri.toString();
7681 }
7682
7683 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
7684 String defPackage, int flags) {
7685 StringBuilder frag = new StringBuilder(128);
7686
7687 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007688 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08007689 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007690 // Note that for now we are not going to try to handle the
7691 // data part; not clear how to represent this as a URI, and
7692 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007693 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
7694 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007695 }
7696
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007697 if (frag.length() > 0) {
7698 uri.append("#Intent;");
7699 uri.append(frag);
7700 uri.append("end");
7701 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007702 }
7703
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007704 private void toUriInner(StringBuilder uri, String scheme, String defAction,
7705 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007706 if (scheme != null) {
7707 uri.append("scheme=").append(scheme).append(';');
7708 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007709 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007710 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007711 }
7712 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007713 for (int i=0; i<mCategories.size(); i++) {
7714 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007715 }
7716 }
7717 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007718 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007719 }
7720 if (mFlags != 0) {
7721 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7722 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007723 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007724 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7725 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007726 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007727 uri.append("component=").append(Uri.encode(
7728 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007729 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007730 if (mSourceBounds != null) {
7731 uri.append("sourceBounds=")
7732 .append(Uri.encode(mSourceBounds.flattenToString()))
7733 .append(';');
7734 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007735 if (mExtras != null) {
7736 for (String key : mExtras.keySet()) {
7737 final Object value = mExtras.get(key);
7738 char entryType =
7739 value instanceof String ? 'S' :
7740 value instanceof Boolean ? 'B' :
7741 value instanceof Byte ? 'b' :
7742 value instanceof Character ? 'c' :
7743 value instanceof Double ? 'd' :
7744 value instanceof Float ? 'f' :
7745 value instanceof Integer ? 'i' :
7746 value instanceof Long ? 'l' :
7747 value instanceof Short ? 's' :
7748 '\0';
7749
7750 if (entryType != '\0') {
7751 uri.append(entryType);
7752 uri.append('.');
7753 uri.append(Uri.encode(key));
7754 uri.append('=');
7755 uri.append(Uri.encode(value.toString()));
7756 uri.append(';');
7757 }
7758 }
7759 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007760 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007761
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007762 public int describeContents() {
7763 return (mExtras != null) ? mExtras.describeContents() : 0;
7764 }
7765
7766 public void writeToParcel(Parcel out, int flags) {
7767 out.writeString(mAction);
7768 Uri.writeToParcel(out, mData);
7769 out.writeString(mType);
7770 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007771 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007772 ComponentName.writeToParcel(mComponent, out);
7773
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007774 if (mSourceBounds != null) {
7775 out.writeInt(1);
7776 mSourceBounds.writeToParcel(out, flags);
7777 } else {
7778 out.writeInt(0);
7779 }
7780
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007781 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007782 final int N = mCategories.size();
7783 out.writeInt(N);
7784 for (int i=0; i<N; i++) {
7785 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007786 }
7787 } else {
7788 out.writeInt(0);
7789 }
7790
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007791 if (mSelector != null) {
7792 out.writeInt(1);
7793 mSelector.writeToParcel(out, flags);
7794 } else {
7795 out.writeInt(0);
7796 }
7797
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007798 if (mClipData != null) {
7799 out.writeInt(1);
7800 mClipData.writeToParcel(out, flags);
7801 } else {
7802 out.writeInt(0);
7803 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007804 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007805 out.writeBundle(mExtras);
7806 }
7807
7808 public static final Parcelable.Creator<Intent> CREATOR
7809 = new Parcelable.Creator<Intent>() {
7810 public Intent createFromParcel(Parcel in) {
7811 return new Intent(in);
7812 }
7813 public Intent[] newArray(int size) {
7814 return new Intent[size];
7815 }
7816 };
7817
Dianne Hackborneb034652009-09-07 00:49:58 -07007818 /** @hide */
7819 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007820 readFromParcel(in);
7821 }
7822
7823 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007824 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007825 mData = Uri.CREATOR.createFromParcel(in);
7826 mType = in.readString();
7827 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007828 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007829 mComponent = ComponentName.readFromParcel(in);
7830
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007831 if (in.readInt() != 0) {
7832 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7833 }
7834
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007835 int N = in.readInt();
7836 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007837 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007838 int i;
7839 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007840 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007841 }
7842 } else {
7843 mCategories = null;
7844 }
7845
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007846 if (in.readInt() != 0) {
7847 mSelector = new Intent(in);
7848 }
7849
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007850 if (in.readInt() != 0) {
7851 mClipData = new ClipData(in);
7852 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007853 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007854 mExtras = in.readBundle();
7855 }
7856
7857 /**
7858 * Parses the "intent" element (and its children) from XML and instantiates
7859 * an Intent object. The given XML parser should be located at the tag
7860 * where parsing should start (often named "intent"), from which the
7861 * basic action, data, type, and package and class name will be
7862 * retrieved. The function will then parse in to any child elements,
7863 * looking for <category android:name="xxx"> tags to add categories and
7864 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7865 * to the intent.
7866 *
7867 * @param resources The Resources to use when inflating resources.
7868 * @param parser The XML parser pointing at an "intent" tag.
7869 * @param attrs The AttributeSet interface for retrieving extended
7870 * attribute data at the current <var>parser</var> location.
7871 * @return An Intent object matching the XML data.
7872 * @throws XmlPullParserException If there was an XML parsing error.
7873 * @throws IOException If there was an I/O error.
7874 */
7875 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7876 throws XmlPullParserException, IOException {
7877 Intent intent = new Intent();
7878
7879 TypedArray sa = resources.obtainAttributes(attrs,
7880 com.android.internal.R.styleable.Intent);
7881
7882 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7883
7884 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7885 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7886 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7887
7888 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7889 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7890 if (packageName != null && className != null) {
7891 intent.setComponent(new ComponentName(packageName, className));
7892 }
7893
7894 sa.recycle();
7895
7896 int outerDepth = parser.getDepth();
7897 int type;
7898 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7899 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7900 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7901 continue;
7902 }
7903
7904 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007905 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007906 sa = resources.obtainAttributes(attrs,
7907 com.android.internal.R.styleable.IntentCategory);
7908 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7909 sa.recycle();
7910
7911 if (cat != null) {
7912 intent.addCategory(cat);
7913 }
7914 XmlUtils.skipCurrentTag(parser);
7915
Craig Mautner21d24a22014-04-23 11:45:37 -07007916 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007917 if (intent.mExtras == null) {
7918 intent.mExtras = new Bundle();
7919 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007920 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007921 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007922
7923 } else {
7924 XmlUtils.skipCurrentTag(parser);
7925 }
7926 }
7927
7928 return intent;
7929 }
Nick Pellyccae4122012-01-09 14:12:58 -08007930
Craig Mautner21d24a22014-04-23 11:45:37 -07007931 /** @hide */
7932 public void saveToXml(XmlSerializer out) throws IOException {
7933 if (mAction != null) {
7934 out.attribute(null, ATTR_ACTION, mAction);
7935 }
7936 if (mData != null) {
7937 out.attribute(null, ATTR_DATA, mData.toString());
7938 }
7939 if (mType != null) {
7940 out.attribute(null, ATTR_TYPE, mType);
7941 }
7942 if (mComponent != null) {
7943 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7944 }
7945 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7946
7947 if (mCategories != null) {
7948 out.startTag(null, TAG_CATEGORIES);
7949 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7950 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7951 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007952 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007953 }
7954 }
7955
7956 /** @hide */
7957 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7958 XmlPullParserException {
7959 Intent intent = new Intent();
7960 final int outerDepth = in.getDepth();
7961
7962 int attrCount = in.getAttributeCount();
7963 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7964 final String attrName = in.getAttributeName(attrNdx);
7965 final String attrValue = in.getAttributeValue(attrNdx);
7966 if (ATTR_ACTION.equals(attrName)) {
7967 intent.setAction(attrValue);
7968 } else if (ATTR_DATA.equals(attrName)) {
7969 intent.setData(Uri.parse(attrValue));
7970 } else if (ATTR_TYPE.equals(attrName)) {
7971 intent.setType(attrValue);
7972 } else if (ATTR_COMPONENT.equals(attrName)) {
7973 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7974 } else if (ATTR_FLAGS.equals(attrName)) {
7975 intent.setFlags(Integer.valueOf(attrValue, 16));
7976 } else {
7977 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7978 }
7979 }
7980
7981 int event;
7982 String name;
7983 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7984 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7985 if (event == XmlPullParser.START_TAG) {
7986 name = in.getName();
7987 if (TAG_CATEGORIES.equals(name)) {
7988 attrCount = in.getAttributeCount();
7989 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7990 intent.addCategory(in.getAttributeValue(attrNdx));
7991 }
7992 } else {
7993 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7994 XmlUtils.skipCurrentTag(in);
7995 }
7996 }
7997 }
7998
7999 return intent;
8000 }
8001
Nick Pellyccae4122012-01-09 14:12:58 -08008002 /**
8003 * Normalize a MIME data type.
8004 *
8005 * <p>A normalized MIME type has white-space trimmed,
8006 * content-type parameters removed, and is lower-case.
8007 * This aligns the type with Android best practices for
8008 * intent filtering.
8009 *
8010 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8011 * "text/x-vCard" becomes "text/x-vcard".
8012 *
8013 * <p>All MIME types received from outside Android (such as user input,
8014 * or external sources like Bluetooth, NFC, or the Internet) should
8015 * be normalized before they are used to create an Intent.
8016 *
8017 * @param type MIME data type to normalize
8018 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008019 * @see #setType
8020 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008021 */
8022 public static String normalizeMimeType(String type) {
8023 if (type == null) {
8024 return null;
8025 }
8026
Elliott Hughescb64d432013-08-02 10:00:44 -07008027 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008028
8029 final int semicolonIndex = type.indexOf(';');
8030 if (semicolonIndex != -1) {
8031 type = type.substring(0, semicolonIndex);
8032 }
8033 return type;
8034 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008035
8036 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008037 * Prepare this {@link Intent} to leave an app process.
8038 *
8039 * @hide
8040 */
8041 public void prepareToLeaveProcess() {
8042 setAllowFds(false);
8043
8044 if (mSelector != null) {
8045 mSelector.prepareToLeaveProcess();
8046 }
8047 if (mClipData != null) {
8048 mClipData.prepareToLeaveProcess();
8049 }
8050
8051 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8052 // There are several ACTION_MEDIA_* broadcasts that send file://
8053 // Uris, so only check common actions.
8054 if (ACTION_VIEW.equals(mAction) ||
8055 ACTION_EDIT.equals(mAction) ||
8056 ACTION_ATTACH_DATA.equals(mAction)) {
8057 mData.checkFileUriExposed("Intent.getData()");
8058 }
8059 }
8060 }
8061
8062 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008063 * @hide
8064 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008065 public void prepareToEnterProcess() {
8066 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008067 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8068 fixUris(mContentUserHint);
8069 mContentUserHint = UserHandle.USER_CURRENT;
8070 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008071 }
8072 }
8073
8074 /**
8075 * @hide
8076 */
8077 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008078 Uri data = getData();
8079 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008080 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008081 }
8082 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008083 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008084 }
8085 String action = getAction();
8086 if (ACTION_SEND.equals(action)) {
8087 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8088 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008089 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008090 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008091 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008092 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8093 if (streams != null) {
8094 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8095 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008096 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008097 }
8098 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8099 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008100 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8101 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8102 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8103 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8104 if (output != null) {
8105 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8106 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008107 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008108 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008109
8110 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008111 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008112 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8113 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008114 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008115 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008116 * @hide
8117 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008118 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008119 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008120 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008121
8122 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008123 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008124
8125 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008126 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008127 // Inspect contained intents to see if we need to migrate extras. We
8128 // don't promote ClipData to the parent, since ChooserActivity will
8129 // already start the picked item as the caller, and we can't combine
8130 // the flags in a safe way.
8131
8132 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008133 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008134 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8135 if (intent != null) {
8136 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008137 }
8138 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008139 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008140 try {
8141 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8142 if (intents != null) {
8143 for (int i = 0; i < intents.length; i++) {
8144 final Intent intent = (Intent) intents[i];
8145 if (intent != null) {
8146 migrated |= intent.migrateExtraStreamToClipData();
8147 }
8148 }
8149 }
8150 } catch (ClassCastException e) {
8151 }
8152 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008153
8154 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008155 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008156 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8157 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
8158 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
8159 if (stream != null || text != null || htmlText != null) {
8160 final ClipData clipData = new ClipData(
8161 null, new String[] { getType() },
8162 new ClipData.Item(text, htmlText, null, stream));
8163 setClipData(clipData);
8164 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008165 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008166 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008167 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008168 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008169
8170 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008171 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008172 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8173 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
8174 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
8175 int num = -1;
8176 if (streams != null) {
8177 num = streams.size();
8178 }
8179 if (texts != null) {
8180 if (num >= 0 && num != texts.size()) {
8181 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008182 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008183 }
8184 num = texts.size();
8185 }
8186 if (htmlTexts != null) {
8187 if (num >= 0 && num != htmlTexts.size()) {
8188 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008189 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008190 }
8191 num = htmlTexts.size();
8192 }
8193 if (num > 0) {
8194 final ClipData clipData = new ClipData(
8195 null, new String[] { getType() },
8196 makeClipItem(streams, texts, htmlTexts, 0));
8197
8198 for (int i = 1; i < num; i++) {
8199 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
8200 }
8201
8202 setClipData(clipData);
8203 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008204 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008205 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008206 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008207 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008208 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8209 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8210 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8211 final Uri output;
8212 try {
8213 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8214 } catch (ClassCastException e) {
8215 return false;
8216 }
8217 if (output != null) {
8218 setClipData(ClipData.newRawUri("", output));
8219 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
8220 return true;
8221 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008222 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008223
8224 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008225 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07008226
8227 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
8228 ArrayList<String> htmlTexts, int which) {
8229 Uri uri = streams != null ? streams.get(which) : null;
8230 CharSequence text = texts != null ? texts.get(which) : null;
8231 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
8232 return new ClipData.Item(text, htmlText, null, uri);
8233 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07008234
8235 /** @hide */
8236 public boolean isDocument() {
8237 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
8238 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008239}