blob: e93cdae8042339431e2ac63355edabc1cea620fd [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010020import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070021import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070023import org.xmlpull.v1.XmlPullParser;
24import org.xmlpull.v1.XmlPullParserException;
25
Tor Norbye7b9c9122013-05-30 16:48:33 -070026import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070027import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070028import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070029import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.annotation.SdkConstant.SdkConstantType;
31import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070032
Nicolas Prevotd85fc722014-04-16 19:52:08 +010033import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070034
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070035import android.content.pm.PackageManager;
36import android.content.pm.ResolveInfo;
37import android.content.res.Resources;
38import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080039import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070040import android.net.Uri;
41import android.os.Bundle;
42import android.os.IBinder;
43import android.os.Parcel;
44import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000045import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070046import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010047import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070048import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070049import android.provider.DocumentsProvider;
50import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070051import android.util.AttributeSet;
52import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080053
54import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070055
Craig Mautner21d24a22014-04-23 11:45:37 -070056import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057
58import java.io.IOException;
59import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070060import java.lang.annotation.Retention;
61import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070062import java.net.URISyntaxException;
63import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070064import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080065import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070066import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070067import java.util.Set;
68
69/**
70 * An intent is an abstract description of an operation to be performed. It
71 * can be used with {@link Context#startActivity(Intent) startActivity} to
72 * launch an {@link android.app.Activity},
73 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
74 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
75 * and {@link android.content.Context#startService} or
76 * {@link android.content.Context#bindService} to communicate with a
77 * background {@link android.app.Service}.
78 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070079 * <p>An Intent provides a facility for performing late runtime binding between the code in
80 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070081 * can be thought of as the glue between activities. It is basically a passive data structure
82 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070083 *
84 * <div class="special reference">
85 * <h3>Developer Guides</h3>
86 * <p>For information about how to create and resolve intents, read the
87 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
88 * developer guide.</p>
89 * </div>
90 *
91 * <a name="IntentStructure"></a>
92 * <h3>Intent Structure</h3>
93 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070094 *
95 * <ul>
96 * <li> <p><b>action</b> -- The general action to be performed, such as
97 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
98 * etc.</p>
99 * </li>
100 * <li> <p><b>data</b> -- The data to operate on, such as a person record
101 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
102 * </li>
103 * </ul>
104 *
105 *
106 * <p>Some examples of action/data pairs are:</p>
107 *
108 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700109 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700110 * information about the person whose identifier is "1".</p>
111 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700112 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700113 * the phone dialer with the person filled in.</p>
114 * </li>
115 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
116 * the phone dialer with the given number filled in. Note how the
117 * VIEW action does what what is considered the most reasonable thing for
118 * a particular URI.</p>
119 * </li>
120 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
121 * the phone dialer with the given number filled in.</p>
122 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700123 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700124 * information about the person whose identifier is "1".</p>
125 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700126 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700127 * a list of people, which the user can browse through. This example is a
128 * typical top-level entry into the Contacts application, showing you the
129 * list of people. Selecting a particular person to view would result in a
130 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
131 * being used to start an activity to display that person.</p>
132 * </li>
133 * </ul>
134 *
135 * <p>In addition to these primary attributes, there are a number of secondary
136 * attributes that you can also include with an intent:</p>
137 *
138 * <ul>
139 * <li> <p><b>category</b> -- Gives additional information about the action
140 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
141 * appear in the Launcher as a top-level application, while
142 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
143 * of alternative actions the user can perform on a piece of data.</p>
144 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
145 * intent data. Normally the type is inferred from the data itself.
146 * By setting this attribute, you disable that evaluation and force
147 * an explicit type.</p>
148 * <li> <p><b>component</b> -- Specifies an explicit name of a component
149 * class to use for the intent. Normally this is determined by looking
150 * at the other information in the intent (the action, data/type, and
151 * categories) and matching that with a component that can handle it.
152 * If this attribute is set then none of the evaluation is performed,
153 * and this component is used exactly as is. By specifying this attribute,
154 * all of the other Intent attributes become optional.</p>
155 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
156 * This can be used to provide extended information to the component.
157 * For example, if we have a action to send an e-mail message, we could
158 * also include extra pieces of data here to supply a subject, body,
159 * etc.</p>
160 * </ul>
161 *
162 * <p>Here are some examples of other operations you can specify as intents
163 * using these additional parameters:</p>
164 *
165 * <ul>
166 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
167 * Launch the home screen.</p>
168 * </li>
169 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
170 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
171 * vnd.android.cursor.item/phone}</i></b>
172 * -- Display the list of people's phone numbers, allowing the user to
173 * browse through them and pick one and return it to the parent activity.</p>
174 * </li>
175 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
176 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
177 * -- Display all pickers for data that can be opened with
178 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
179 * allowing the user to pick one of them and then some data inside of it
180 * and returning the resulting URI to the caller. This can be used,
181 * for example, in an e-mail application to allow the user to pick some
182 * data to include as an attachment.</p>
183 * </li>
184 * </ul>
185 *
186 * <p>There are a variety of standard Intent action and category constants
187 * defined in the Intent class, but applications can also define their own.
188 * These strings use java style scoping, to ensure they are unique -- for
189 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700190 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700191 *
192 * <p>Put together, the set of actions, data types, categories, and extra data
193 * defines a language for the system allowing for the expression of phrases
194 * such as "call john smith's cell". As applications are added to the system,
195 * they can extend this language by adding new actions, types, and categories, or
196 * they can modify the behavior of existing phrases by supplying their own
197 * activities that handle them.</p>
198 *
199 * <a name="IntentResolution"></a>
200 * <h3>Intent Resolution</h3>
201 *
202 * <p>There are two primary forms of intents you will use.
203 *
204 * <ul>
205 * <li> <p><b>Explicit Intents</b> have specified a component (via
206 * {@link #setComponent} or {@link #setClass}), which provides the exact
207 * class to be run. Often these will not include any other information,
208 * simply being a way for an application to launch various internal
209 * activities it has as the user interacts with the application.
210 *
211 * <li> <p><b>Implicit Intents</b> have not specified a component;
212 * instead, they must include enough information for the system to
213 * determine which of the available components is best to run for that
214 * intent.
215 * </ul>
216 *
217 * <p>When using implicit intents, given such an arbitrary intent we need to
218 * know what to do with it. This is handled by the process of <em>Intent
219 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
220 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
221 * more activities/receivers) that can handle it.</p>
222 *
223 * <p>The intent resolution mechanism basically revolves around matching an
224 * Intent against all of the &lt;intent-filter&gt; descriptions in the
225 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
226 * objects explicitly registered with {@link Context#registerReceiver}.) More
227 * details on this can be found in the documentation on the {@link
228 * IntentFilter} class.</p>
229 *
230 * <p>There are three pieces of information in the Intent that are used for
231 * resolution: the action, type, and category. Using this information, a query
232 * is done on the {@link PackageManager} for a component that can handle the
233 * intent. The appropriate component is determined based on the intent
234 * information supplied in the <code>AndroidManifest.xml</code> file as
235 * follows:</p>
236 *
237 * <ul>
238 * <li> <p>The <b>action</b>, if given, must be listed by the component as
239 * one it handles.</p>
240 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
241 * already supplied in the Intent. Like the action, if a type is
242 * included in the intent (either explicitly or implicitly in its
243 * data), then this must be listed by the component as one it handles.</p>
244 * <li> For data that is not a <code>content:</code> URI and where no explicit
245 * type is included in the Intent, instead the <b>scheme</b> of the
246 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
247 * considered. Again like the action, if we are matching a scheme it
248 * must be listed by the component as one it can handle.
249 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
250 * by the activity as categories it handles. That is, if you include
251 * the categories {@link #CATEGORY_LAUNCHER} and
252 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
253 * with an intent that lists <em>both</em> of those categories.
254 * Activities will very often need to support the
255 * {@link #CATEGORY_DEFAULT} so that they can be found by
256 * {@link Context#startActivity Context.startActivity()}.</p>
257 * </ul>
258 *
259 * <p>For example, consider the Note Pad sample application that
260 * allows user to browse through a list of notes data and view details about
261 * individual items. Text in italics indicate places were you would replace a
262 * name with one specific to your own package.</p>
263 *
264 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
265 * package="<i>com.android.notepad</i>"&gt;
266 * &lt;application android:icon="@drawable/app_notes"
267 * android:label="@string/app_name"&gt;
268 *
269 * &lt;provider class=".NotePadProvider"
270 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
271 *
272 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
273 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700274 * &lt;action android:name="android.intent.action.MAIN" /&gt;
275 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700276 * &lt;/intent-filter&gt;
277 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700278 * &lt;action android:name="android.intent.action.VIEW" /&gt;
279 * &lt;action android:name="android.intent.action.EDIT" /&gt;
280 * &lt;action android:name="android.intent.action.PICK" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700285 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
286 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
287 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700288 * &lt;/intent-filter&gt;
289 * &lt;/activity&gt;
290 *
291 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
292 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700293 * &lt;action android:name="android.intent.action.VIEW" /&gt;
294 * &lt;action android:name="android.intent.action.EDIT" /&gt;
295 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
296 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700297 * &lt;/intent-filter&gt;
298 *
299 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700300 * &lt;action android:name="android.intent.action.INSERT" /&gt;
301 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
302 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700303 * &lt;/intent-filter&gt;
304 *
305 * &lt;/activity&gt;
306 *
307 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
308 * android:theme="@android:style/Theme.Dialog"&gt;
309 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700310 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
311 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
312 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
313 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
314 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700315 * &lt;/intent-filter&gt;
316 * &lt;/activity&gt;
317 *
318 * &lt;/application&gt;
319 * &lt;/manifest&gt;</pre>
320 *
321 * <p>The first activity,
322 * <code>com.android.notepad.NotesList</code>, serves as our main
323 * entry into the app. It can do three things as described by its three intent
324 * templates:
325 * <ol>
326 * <li><pre>
327 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700328 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
329 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700330 * &lt;/intent-filter&gt;</pre>
331 * <p>This provides a top-level entry into the NotePad application: the standard
332 * MAIN action is a main entry point (not requiring any other information in
333 * the Intent), and the LAUNCHER category says that this entry point should be
334 * listed in the application launcher.</p>
335 * <li><pre>
336 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700337 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
338 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
339 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
340 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
341 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700342 * &lt;/intent-filter&gt;</pre>
343 * <p>This declares the things that the activity can do on a directory of
344 * notes. The type being supported is given with the &lt;type&gt; tag, where
345 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
346 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
347 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
348 * The activity allows the user to view or edit the directory of data (via
349 * the VIEW and EDIT actions), or to pick a particular note and return it
350 * to the caller (via the PICK action). Note also the DEFAULT category
351 * supplied here: this is <em>required</em> for the
352 * {@link Context#startActivity Context.startActivity} method to resolve your
353 * activity when its component name is not explicitly specified.</p>
354 * <li><pre>
355 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700356 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
357 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
358 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700359 * &lt;/intent-filter&gt;</pre>
360 * <p>This filter describes the ability return to the caller a note selected by
361 * the user without needing to know where it came from. The data type
362 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
363 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
364 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
365 * The GET_CONTENT action is similar to the PICK action, where the activity
366 * will return to its caller a piece of data selected by the user. Here,
367 * however, the caller specifies the type of data they desire instead of
368 * the type of data the user will be picking from.</p>
369 * </ol>
370 *
371 * <p>Given these capabilities, the following intents will resolve to the
372 * NotesList activity:</p>
373 *
374 * <ul>
375 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
376 * activities that can be used as top-level entry points into an
377 * application.</p>
378 * <li> <p><b>{ action=android.app.action.MAIN,
379 * category=android.app.category.LAUNCHER }</b> is the actual intent
380 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700381 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700382 * data=content://com.google.provider.NotePad/notes }</b>
383 * displays a list of all the notes under
384 * "content://com.google.provider.NotePad/notes", which
385 * the user can browse through and see the details on.</p>
386 * <li> <p><b>{ action=android.app.action.PICK
387 * data=content://com.google.provider.NotePad/notes }</b>
388 * provides a list of the notes under
389 * "content://com.google.provider.NotePad/notes", from which
390 * the user can pick a note whose data URL is returned back to the caller.</p>
391 * <li> <p><b>{ action=android.app.action.GET_CONTENT
392 * type=vnd.android.cursor.item/vnd.google.note }</b>
393 * is similar to the pick action, but allows the caller to specify the
394 * kind of data they want back so that the system can find the appropriate
395 * activity to pick something of that data type.</p>
396 * </ul>
397 *
398 * <p>The second activity,
399 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
400 * note entry and allows them to edit it. It can do two things as described
401 * by its two intent templates:
402 * <ol>
403 * <li><pre>
404 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700405 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
406 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
407 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
408 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700409 * &lt;/intent-filter&gt;</pre>
410 * <p>The first, primary, purpose of this activity is to let the user interact
411 * with a single note, as decribed by the MIME type
412 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
413 * either VIEW a note or allow the user to EDIT it. Again we support the
414 * DEFAULT category to allow the activity to be launched without explicitly
415 * specifying its component.</p>
416 * <li><pre>
417 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700418 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
419 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
420 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700421 * &lt;/intent-filter&gt;</pre>
422 * <p>The secondary use of this activity is to insert a new note entry into
423 * an existing directory of notes. This is used when the user creates a new
424 * note: the INSERT action is executed on the directory of notes, causing
425 * this activity to run and have the user create the new note data which
426 * it then adds to the content provider.</p>
427 * </ol>
428 *
429 * <p>Given these capabilities, the following intents will resolve to the
430 * NoteEditor activity:</p>
431 *
432 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700433 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700434 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
435 * shows the user the content of note <var>{ID}</var>.</p>
436 * <li> <p><b>{ action=android.app.action.EDIT
437 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
438 * allows the user to edit the content of note <var>{ID}</var>.</p>
439 * <li> <p><b>{ action=android.app.action.INSERT
440 * data=content://com.google.provider.NotePad/notes }</b>
441 * creates a new, empty note in the notes list at
442 * "content://com.google.provider.NotePad/notes"
443 * and allows the user to edit it. If they keep their changes, the URI
444 * of the newly created note is returned to the caller.</p>
445 * </ul>
446 *
447 * <p>The last activity,
448 * <code>com.android.notepad.TitleEditor</code>, allows the user to
449 * edit the title of a note. This could be implemented as a class that the
450 * application directly invokes (by explicitly setting its component in
451 * the Intent), but here we show a way you can publish alternative
452 * operations on existing data:</p>
453 *
454 * <pre>
455 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700456 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
457 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
460 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700461 * &lt;/intent-filter&gt;</pre>
462 *
463 * <p>In the single intent template here, we
464 * have created our own private action called
465 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
466 * edit the title of a note. It must be invoked on a specific note
467 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
468 * view and edit actions, but here displays and edits the title contained
469 * in the note data.
470 *
471 * <p>In addition to supporting the default category as usual, our title editor
472 * also supports two other standard categories: ALTERNATIVE and
473 * SELECTED_ALTERNATIVE. Implementing
474 * these categories allows others to find the special action it provides
475 * without directly knowing about it, through the
476 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
477 * more often to build dynamic menu items with
478 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
479 * template here was also supply an explicit name for the template
480 * (via <code>android:label="@string/resolve_title"</code>) to better control
481 * what the user sees when presented with this activity as an alternative
482 * action to the data they are viewing.
483 *
484 * <p>Given these capabilities, the following intent will resolve to the
485 * TitleEditor activity:</p>
486 *
487 * <ul>
488 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
489 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
490 * displays and allows the user to edit the title associated
491 * with note <var>{ID}</var>.</p>
492 * </ul>
493 *
494 * <h3>Standard Activity Actions</h3>
495 *
496 * <p>These are the current standard actions that Intent defines for launching
497 * activities (usually through {@link Context#startActivity}. The most
498 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
499 * {@link #ACTION_EDIT}.
500 *
501 * <ul>
502 * <li> {@link #ACTION_MAIN}
503 * <li> {@link #ACTION_VIEW}
504 * <li> {@link #ACTION_ATTACH_DATA}
505 * <li> {@link #ACTION_EDIT}
506 * <li> {@link #ACTION_PICK}
507 * <li> {@link #ACTION_CHOOSER}
508 * <li> {@link #ACTION_GET_CONTENT}
509 * <li> {@link #ACTION_DIAL}
510 * <li> {@link #ACTION_CALL}
511 * <li> {@link #ACTION_SEND}
512 * <li> {@link #ACTION_SENDTO}
513 * <li> {@link #ACTION_ANSWER}
514 * <li> {@link #ACTION_INSERT}
515 * <li> {@link #ACTION_DELETE}
516 * <li> {@link #ACTION_RUN}
517 * <li> {@link #ACTION_SYNC}
518 * <li> {@link #ACTION_PICK_ACTIVITY}
519 * <li> {@link #ACTION_SEARCH}
520 * <li> {@link #ACTION_WEB_SEARCH}
521 * <li> {@link #ACTION_FACTORY_TEST}
522 * </ul>
523 *
524 * <h3>Standard Broadcast Actions</h3>
525 *
526 * <p>These are the current standard actions that Intent defines for receiving
527 * broadcasts (usually through {@link Context#registerReceiver} or a
528 * &lt;receiver&gt; tag in a manifest).
529 *
530 * <ul>
531 * <li> {@link #ACTION_TIME_TICK}
532 * <li> {@link #ACTION_TIME_CHANGED}
533 * <li> {@link #ACTION_TIMEZONE_CHANGED}
534 * <li> {@link #ACTION_BOOT_COMPLETED}
535 * <li> {@link #ACTION_PACKAGE_ADDED}
536 * <li> {@link #ACTION_PACKAGE_CHANGED}
537 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800538 * <li> {@link #ACTION_PACKAGE_RESTARTED}
539 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #ACTION_UID_REMOVED}
541 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700542 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700543 * <li> {@link #ACTION_POWER_DISCONNECTED}
544 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700545 * </ul>
546 *
547 * <h3>Standard Categories</h3>
548 *
549 * <p>These are the current standard categories that can be used to further
550 * clarify an Intent via {@link #addCategory}.
551 *
552 * <ul>
553 * <li> {@link #CATEGORY_DEFAULT}
554 * <li> {@link #CATEGORY_BROWSABLE}
555 * <li> {@link #CATEGORY_TAB}
556 * <li> {@link #CATEGORY_ALTERNATIVE}
557 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
558 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800559 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700560 * <li> {@link #CATEGORY_HOME}
561 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700562 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400563 * <li> {@link #CATEGORY_CAR_DOCK}
564 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500565 * <li> {@link #CATEGORY_LE_DESK_DOCK}
566 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200567 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700568 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700569 * </ul>
570 *
571 * <h3>Standard Extra Data</h3>
572 *
573 * <p>These are the current standard fields that can be used as extra data via
574 * {@link #putExtra}.
575 *
576 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800577 * <li> {@link #EXTRA_ALARM_COUNT}
578 * <li> {@link #EXTRA_BCC}
579 * <li> {@link #EXTRA_CC}
580 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
581 * <li> {@link #EXTRA_DATA_REMOVED}
582 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500583 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
584 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800585 * <li> {@link #EXTRA_DOCK_STATE_CAR}
586 * <li> {@link #EXTRA_DOCK_STATE_DESK}
587 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
588 * <li> {@link #EXTRA_DONT_KILL_APP}
589 * <li> {@link #EXTRA_EMAIL}
590 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700591 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800592 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700593 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800594 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700595 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800596 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
597 * <li> {@link #EXTRA_REPLACING}
598 * <li> {@link #EXTRA_SHORTCUT_ICON}
599 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
600 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700601 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800602 * <li> {@link #EXTRA_SHORTCUT_NAME}
603 * <li> {@link #EXTRA_SUBJECT}
604 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_TITLE}
607 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * </ul>
609 *
610 * <h3>Flags</h3>
611 *
612 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800613 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
614 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700615 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800616public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700617 private static final String ATTR_ACTION = "action";
618 private static final String TAG_CATEGORIES = "categories";
619 private static final String ATTR_CATEGORY = "category";
620 private static final String TAG_EXTRA = "extra";
621 private static final String ATTR_TYPE = "type";
622 private static final String ATTR_COMPONENT = "component";
623 private static final String ATTR_DATA = "data";
624 private static final String ATTR_FLAGS = "flags";
625
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700626 // ---------------------------------------------------------------------
627 // ---------------------------------------------------------------------
628 // Standard intent activity actions (see action variable).
629
630 /**
631 * Activity Action: Start as a main entry point, does not expect to
632 * receive data.
633 * <p>Input: nothing
634 * <p>Output: nothing
635 */
636 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
637 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700639 /**
640 * Activity Action: Display the data to the user. This is the most common
641 * action performed on data -- it is the generic action you can use on
642 * a piece of data to get the most reasonable thing to occur. For example,
643 * when used on a contacts entry it will view the entry; when used on a
644 * mailto: URI it will bring up a compose window filled with the information
645 * supplied by the URI; when used with a tel: URI it will invoke the
646 * dialer.
647 * <p>Input: {@link #getData} is URI from which to retrieve data.
648 * <p>Output: nothing.
649 */
650 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
651 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700653 /**
654 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
655 * performed on a piece of data.
656 */
657 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800658
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700659 /**
660 * Used to indicate that some piece of data should be attached to some other
661 * place. For example, image data could be attached to a contact. It is up
662 * to the recipient to decide where the data should be attached; the intent
663 * does not specify the ultimate destination.
664 * <p>Input: {@link #getData} is URI of data to be attached.
665 * <p>Output: nothing.
666 */
667 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
668 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 /**
671 * Activity Action: Provide explicit editable access to the given data.
672 * <p>Input: {@link #getData} is URI of data to be edited.
673 * <p>Output: nothing.
674 */
675 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
676 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800677
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 /**
679 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
680 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
681 * The extras can contain type specific data to pass through to the editing/creating
682 * activity.
683 * <p>Output: The URI of the item that was picked. This must be a content:
684 * URI so that any receiver can access it.
685 */
686 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
687 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700689 /**
690 * Activity Action: Pick an item from the data, returning what was selected.
691 * <p>Input: {@link #getData} is URI containing a directory of data
692 * (vnd.android.cursor.dir/*) from which to pick an item.
693 * <p>Output: The URI of the item that was picked.
694 */
695 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
696 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800697
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700698 /**
699 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800700 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700701 * <p>Output: An Intent representing the shortcut. The intent must contain three
702 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
703 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800704 * (value: ShortcutIconResource).</p>
705 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700706 * @see #EXTRA_SHORTCUT_INTENT
707 * @see #EXTRA_SHORTCUT_NAME
708 * @see #EXTRA_SHORTCUT_ICON
709 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
710 * @see android.content.Intent.ShortcutIconResource
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
714
715 /**
716 * The name of the extra used to define the Intent of a shortcut.
717 *
718 * @see #ACTION_CREATE_SHORTCUT
719 */
720 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
721 /**
722 * The name of the extra used to define the name of a shortcut.
723 *
724 * @see #ACTION_CREATE_SHORTCUT
725 */
726 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
727 /**
728 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
729 *
730 * @see #ACTION_CREATE_SHORTCUT
731 */
732 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
733 /**
734 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
735 *
736 * @see #ACTION_CREATE_SHORTCUT
737 * @see android.content.Intent.ShortcutIconResource
738 */
739 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
740 "android.intent.extra.shortcut.ICON_RESOURCE";
741
742 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800743 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700744 *
745 * @see Intent#ACTION_CREATE_SHORTCUT
746 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800747 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
748 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700749 */
750 public static class ShortcutIconResource implements Parcelable {
751 /**
752 * The package name of the application containing the icon.
753 */
754 public String packageName;
755
756 /**
757 * The resource name of the icon, including package, name and type.
758 */
759 public String resourceName;
760
761 /**
762 * Creates a new ShortcutIconResource for the specified context and resource
763 * identifier.
764 *
765 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700766 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700767 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700768 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700769 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700770 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700771 ShortcutIconResource icon = new ShortcutIconResource();
772 icon.packageName = context.getPackageName();
773 icon.resourceName = context.getResources().getResourceName(resourceId);
774 return icon;
775 }
776
777 /**
778 * Used to read a ShortcutIconResource from a Parcel.
779 */
780 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
781 new Parcelable.Creator<ShortcutIconResource>() {
782
783 public ShortcutIconResource createFromParcel(Parcel source) {
784 ShortcutIconResource icon = new ShortcutIconResource();
785 icon.packageName = source.readString();
786 icon.resourceName = source.readString();
787 return icon;
788 }
789
790 public ShortcutIconResource[] newArray(int size) {
791 return new ShortcutIconResource[size];
792 }
793 };
794
795 /**
796 * No special parcel contents.
797 */
798 public int describeContents() {
799 return 0;
800 }
801
802 public void writeToParcel(Parcel dest, int flags) {
803 dest.writeString(packageName);
804 dest.writeString(resourceName);
805 }
806
807 @Override
808 public String toString() {
809 return resourceName;
810 }
811 }
812
813 /**
814 * Activity Action: Display an activity chooser, allowing the user to pick
815 * what they want to before proceeding. This can be used as an alternative
816 * to the standard activity picker that is displayed by the system when
817 * you try to start an activity with multiple possible matches, with these
818 * differences in behavior:
819 * <ul>
820 * <li>You can specify the title that will appear in the activity chooser.
821 * <li>The user does not have the option to make one of the matching
822 * activities a preferred activity, and all possible activities will
823 * always be shown even if one of them is currently marked as the
824 * preferred activity.
825 * </ul>
826 * <p>
827 * This action should be used when the user will naturally expect to
828 * select an activity in order to proceed. An example if when not to use
829 * it is when the user clicks on a "mailto:" link. They would naturally
830 * expect to go directly to their mail app, so startActivity() should be
831 * called directly: it will
832 * either launch the current preferred app, or put up a dialog allowing the
833 * user to pick an app to use and optionally marking that as preferred.
834 * <p>
835 * In contrast, if the user is selecting a menu item to send a picture
836 * they are viewing to someone else, there are many different things they
837 * may want to do at this point: send it through e-mail, upload it to a
838 * web service, etc. In this case the CHOOSER action should be used, to
839 * always present to the user a list of the things they can do, with a
840 * nice title given by the caller such as "Send this photo with:".
841 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700842 * If you need to grant URI permissions through a chooser, you must specify
843 * the permissions to be granted on the ACTION_CHOOSER Intent
844 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
845 * {@link #setClipData} to specify the URIs to be granted as well as
846 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
847 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
848 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700849 * As a convenience, an Intent of this form can be created with the
850 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700851 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700852 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700853 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
854 * and can optionally have a {@link #EXTRA_TITLE} field containing the
855 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700856 * <p>
857 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700858 */
859 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
860 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
861
862 /**
863 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
864 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700865 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
866 * target intent, also optionally supplying a title. If the target
867 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
868 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
869 * set in the returned chooser intent, with its ClipData set appropriately:
870 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500871 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700872 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700873 * @param target The Intent that the user will be selecting an activity
874 * to perform.
875 * @param title Optional title that will be displayed in the chooser.
876 * @return Return a new Intent object that you can hand to
877 * {@link Context#startActivity(Intent) Context.startActivity()} and
878 * related methods.
879 */
880 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700881 return createChooser(target, title, null);
882 }
883
884 /**
885 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
886 *
887 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
888 * target intent, also optionally supplying a title. If the target
889 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
890 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
891 * set in the returned chooser intent, with its ClipData set appropriately:
892 * either a direct reflection of {@link #getClipData()} if that is non-null,
893 * or a new ClipData built from {@link #getData()}.</p>
894 *
895 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
896 * when the user makes a choice. This can be useful if the calling application wants
897 * to remember the last chosen target and surface it as a more prominent or one-touch
898 * affordance elsewhere in the UI for next time.</p>
899 *
900 * @param target The Intent that the user will be selecting an activity
901 * to perform.
902 * @param title Optional title that will be displayed in the chooser.
903 * @param sender Optional IntentSender to be called when a choice is made.
904 * @return Return a new Intent object that you can hand to
905 * {@link Context#startActivity(Intent) Context.startActivity()} and
906 * related methods.
907 */
908 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700909 Intent intent = new Intent(ACTION_CHOOSER);
910 intent.putExtra(EXTRA_INTENT, target);
911 if (title != null) {
912 intent.putExtra(EXTRA_TITLE, title);
913 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700914
Adam Powell0b3c1122014-10-09 12:50:14 -0700915 if (sender != null) {
916 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
917 }
918
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700919 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700920 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
921 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
922 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700923 if (permFlags != 0) {
924 ClipData targetClipData = target.getClipData();
925 if (targetClipData == null && target.getData() != null) {
926 ClipData.Item item = new ClipData.Item(target.getData());
927 String[] mimeTypes;
928 if (target.getType() != null) {
929 mimeTypes = new String[] { target.getType() };
930 } else {
931 mimeTypes = new String[] { };
932 }
933 targetClipData = new ClipData(null, mimeTypes, item);
934 }
935 if (targetClipData != null) {
936 intent.setClipData(targetClipData);
937 intent.addFlags(permFlags);
938 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700939 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700940
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700941 return intent;
942 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700943
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700944 /**
945 * Activity Action: Allow the user to select a particular kind of data and
946 * return it. This is different than {@link #ACTION_PICK} in that here we
947 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800948 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700949 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900950 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700951 * etc.
952 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900953 * 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 -0700954 * of data, such as a person contact, you set the MIME type to the kind of
955 * data you want and launch it with {@link Context#startActivity(Intent)}.
956 * The system will then launch the best application to select that kind
957 * of data for you.
958 * <p>
959 * You may also be interested in any of a set of types of content the user
960 * can pick. For example, an e-mail application that wants to allow the
961 * user to add an attachment to an e-mail message can use this action to
962 * bring up a list of all of the types of content the user can attach.
963 * <p>
964 * In this case, you should wrap the GET_CONTENT intent with a chooser
965 * (through {@link #createChooser}), which will give the proper interface
966 * for the user to pick how to send your data and allow you to specify
967 * a prompt indicating what they are doing. You will usually specify a
968 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
969 * broad range of content types the user can select from.
970 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900971 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700972 * only pick from data that can be represented as a stream. This is
973 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
974 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800975 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900976 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800977 * is locally available on the device. For example, if this extra is set
978 * to true then an image picker should not show any pictures that are available
979 * from a remote server but not already on the local device (thus requiring
980 * they be downloaded when opened).
981 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800982 * If the caller can handle multiple returned items (the user performing
983 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
984 * to indicate this.
985 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700986 * Input: {@link #getType} is the desired MIME type to retrieve. Note
987 * that no URI is supplied in the intent, as there are no constraints on
988 * where the returned data originally comes from. You may also include the
989 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800990 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800991 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
992 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700993 * <p>
994 * Output: The URI of the item that was picked. This must be a content:
995 * URI so that any receiver can access it.
996 */
997 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
998 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
999 /**
1000 * Activity Action: Dial a number as specified by the data. This shows a
1001 * UI with the number being dialed, allowing the user to explicitly
1002 * initiate the call.
1003 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1004 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1005 * number.
1006 * <p>Output: nothing.
1007 */
1008 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1009 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1010 /**
1011 * Activity Action: Perform a call to someone specified by the data.
1012 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1013 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1014 * number.
1015 * <p>Output: nothing.
1016 *
1017 * <p>Note: there will be restrictions on which applications can initiate a
1018 * call; most applications should use the {@link #ACTION_DIAL}.
1019 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1020 * numbers. Applications can <strong>dial</strong> emergency numbers using
1021 * {@link #ACTION_DIAL}, however.
1022 */
1023 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1024 public static final String ACTION_CALL = "android.intent.action.CALL";
1025 /**
1026 * Activity Action: Perform a call to an emergency number specified by the
1027 * data.
1028 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1029 * tel: URI of an explicit phone number.
1030 * <p>Output: nothing.
1031 * @hide
1032 */
1033 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1034 /**
1035 * Activity action: Perform a call to any number (emergency or not)
1036 * specified by the data.
1037 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1038 * tel: URI of an explicit phone number.
1039 * <p>Output: nothing.
1040 * @hide
1041 */
1042 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1043 /**
1044 * Activity Action: Send a message to someone specified by the data.
1045 * <p>Input: {@link #getData} is URI describing the target.
1046 * <p>Output: nothing.
1047 */
1048 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1049 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1050 /**
1051 * Activity Action: Deliver some data to someone else. Who the data is
1052 * being delivered to is not specified; it is up to the receiver of this
1053 * action to ask the user where the data should be sent.
1054 * <p>
1055 * When launching a SEND intent, you should usually wrap it in a chooser
1056 * (through {@link #createChooser}), which will give the proper interface
1057 * for the user to pick how to send your data and allow you to specify
1058 * a prompt indicating what they are doing.
1059 * <p>
1060 * Input: {@link #getType} is the MIME type of the data being sent.
1061 * get*Extra can have either a {@link #EXTRA_TEXT}
1062 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1063 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1064 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1065 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001066 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1067 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1068 * your text with HTML formatting.
1069 * <p>
1070 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1071 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1072 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1073 * content: URIs and other advanced features of {@link ClipData}. If
1074 * using this approach, you still must supply the same data through the
1075 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1076 * for compatibility with old applications. If you don't set a ClipData,
1077 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001078 * <p>
1079 * Optional standard extras, which may be interpreted by some recipients as
1080 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1081 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1082 * <p>
1083 * Output: nothing.
1084 */
1085 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1086 public static final String ACTION_SEND = "android.intent.action.SEND";
1087 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001088 * Activity Action: Deliver multiple data to someone else.
1089 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001090 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001091 * <p>
1092 * Input: {@link #getType} is the MIME type of the data being sent.
1093 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001094 * #EXTRA_STREAM} field, containing the data to be sent. If using
1095 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1096 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001097 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001098 * Multiple types are supported, and receivers should handle mixed types
1099 * whenever possible. The right way for the receiver to check them is to
1100 * use the content resolver on each URI. The intent sender should try to
1101 * put the most concrete mime type in the intent type, but it can fall
1102 * back to {@literal <type>/*} or {@literal *}/* as needed.
1103 * <p>
1104 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1105 * be image/jpg, but if you are sending image/jpg and image/png, then the
1106 * intent's type should be image/*.
1107 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001108 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1109 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1110 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1111 * content: URIs and other advanced features of {@link ClipData}. If
1112 * using this approach, you still must supply the same data through the
1113 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1114 * for compatibility with old applications. If you don't set a ClipData,
1115 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1116 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001117 * Optional standard extras, which may be interpreted by some recipients as
1118 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1119 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1120 * <p>
1121 * Output: nothing.
1122 */
1123 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1124 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1125 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001126 * Activity Action: Handle an incoming phone call.
1127 * <p>Input: nothing.
1128 * <p>Output: nothing.
1129 */
1130 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1131 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1132 /**
1133 * Activity Action: Insert an empty item into the given container.
1134 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1135 * in which to place the data.
1136 * <p>Output: URI of the new data that was created.
1137 */
1138 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1139 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1140 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001141 * Activity Action: Create a new item in the given container, initializing it
1142 * from the current contents of the clipboard.
1143 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1144 * in which to place the data.
1145 * <p>Output: URI of the new data that was created.
1146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1149 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001150 * Activity Action: Delete the given data from its container.
1151 * <p>Input: {@link #getData} is URI of data to be deleted.
1152 * <p>Output: nothing.
1153 */
1154 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1155 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1156 /**
1157 * Activity Action: Run the data, whatever that means.
1158 * <p>Input: ? (Note: this is currently specific to the test harness.)
1159 * <p>Output: nothing.
1160 */
1161 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1162 public static final String ACTION_RUN = "android.intent.action.RUN";
1163 /**
1164 * Activity Action: Perform a data synchronization.
1165 * <p>Input: ?
1166 * <p>Output: ?
1167 */
1168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1169 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1170 /**
1171 * Activity Action: Pick an activity given an intent, returning the class
1172 * selected.
1173 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1174 * used with {@link PackageManager#queryIntentActivities} to determine the
1175 * set of activities from which to pick.
1176 * <p>Output: Class name of the activity that was selected.
1177 */
1178 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1179 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1180 /**
1181 * Activity Action: Perform a search.
1182 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1183 * is the text to search for. If empty, simply
1184 * enter your search results Activity with the search UI activated.
1185 * <p>Output: nothing.
1186 */
1187 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1188 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1189 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001190 * Activity Action: Start the platform-defined tutorial
1191 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1192 * is the text to search for. If empty, simply
1193 * enter your search results Activity with the search UI activated.
1194 * <p>Output: nothing.
1195 */
1196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1197 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1198 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001199 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001200 * <p>
1201 * Input: {@link android.app.SearchManager#QUERY
1202 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1203 * a url starts with http or https, the site will be opened. If it is plain
1204 * text, Google search will be applied.
1205 * <p>
1206 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001207 */
1208 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1209 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001210
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001211 /**
Jim Miller07994402012-05-02 14:22:27 -07001212 * Activity Action: Perform assist action.
1213 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001214 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1215 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001216 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001217 * Output: nothing.
1218 */
1219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1220 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001221
1222 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001223 * Activity Action: Perform voice assist action.
1224 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001225 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1226 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001227 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001228 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001229 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001230 */
1231 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1232 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1233
1234 /**
Adam Skory7140a252013-09-11 12:04:58 +01001235 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1236 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001237 */
1238 public static final String EXTRA_ASSIST_PACKAGE
1239 = "android.intent.extra.ASSIST_PACKAGE";
1240
1241 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001242 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1243 * application package at the time the assist was invoked.
1244 */
1245 public static final String EXTRA_ASSIST_UID
1246 = "android.intent.extra.ASSIST_UID";
1247
1248 /**
Adam Skory7140a252013-09-11 12:04:58 +01001249 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1250 * information supplied by the current foreground app at the time of the assist request.
1251 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001252 */
1253 public static final String EXTRA_ASSIST_CONTEXT
1254 = "android.intent.extra.ASSIST_CONTEXT";
1255
Jim Miller07994402012-05-02 14:22:27 -07001256 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001257 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1258 * keyboard as the primary input device for assistance.
1259 */
1260 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1261 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1262
1263 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001264 * Activity Action: List all available applications
1265 * <p>Input: Nothing.
1266 * <p>Output: nothing.
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1270 /**
1271 * Activity Action: Show settings for choosing wallpaper
1272 * <p>Input: Nothing.
1273 * <p>Output: Nothing.
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1277
1278 /**
1279 * Activity Action: Show activity for reporting a bug.
1280 * <p>Input: Nothing.
1281 * <p>Output: Nothing.
1282 */
1283 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1284 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1285
1286 /**
1287 * Activity Action: Main entry point for factory tests. Only used when
1288 * the device is booting in factory test node. The implementing package
1289 * must be installed in the system image.
1290 * <p>Input: nothing
1291 * <p>Output: nothing
1292 */
1293 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1294
1295 /**
1296 * Activity Action: The user pressed the "call" button to go to the dialer
1297 * or other appropriate UI for placing a call.
1298 * <p>Input: Nothing.
1299 * <p>Output: Nothing.
1300 */
1301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1302 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1303
1304 /**
1305 * Activity Action: Start Voice Command.
1306 * <p>Input: Nothing.
1307 * <p>Output: Nothing.
1308 */
1309 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1310 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001311
1312 /**
1313 * Activity Action: Start action associated with long pressing on the
1314 * search key.
1315 * <p>Input: Nothing.
1316 * <p>Output: Nothing.
1317 */
1318 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1319 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001320
Jacek Surazski86b6c532009-05-13 14:38:28 +02001321 /**
1322 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1323 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001324 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001325 * <p>Input: No data is specified. The bug report is passed in using
1326 * an {@link #EXTRA_BUG_REPORT} field.
1327 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001328 *
1329 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001333
1334 /**
1335 * Activity Action: Show power usage information to the user.
1336 * <p>Input: Nothing.
1337 * <p>Output: Nothing.
1338 */
1339 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1340 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001341
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001342 /**
1343 * Activity Action: Setup wizard to launch after a platform update. This
1344 * activity should have a string meta-data field associated with it,
1345 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1346 * the platform for setup. The activity will be launched only if
1347 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1348 * same value.
1349 * <p>Input: Nothing.
1350 * <p>Output: Nothing.
1351 * @hide
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001355
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001356 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001357 * Activity Action: Show settings for managing network data usage of a
1358 * specific application. Applications should define an activity that offers
1359 * options to control data usage.
1360 */
1361 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1362 public static final String ACTION_MANAGE_NETWORK_USAGE =
1363 "android.intent.action.MANAGE_NETWORK_USAGE";
1364
1365 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001366 * Activity Action: Launch application installer.
1367 * <p>
1368 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001369 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1370 * you can also use "package:<package-name>" to install an application for the
1371 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001372 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1373 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1374 * <p>
1375 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1376 * succeeded.
1377 *
1378 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1379 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1380 * @see #EXTRA_RETURN_RESULT
1381 */
1382 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1383 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1384
1385 /**
1386 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1387 * package. Specifies the installer package name; this package will receive the
1388 * {@link #ACTION_APP_ERROR} intent.
1389 */
1390 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1391 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1392
1393 /**
1394 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1395 * package. Specifies that the application being installed should not be
1396 * treated as coming from an unknown source, but as coming from the app
1397 * invoking the Intent. For this to work you must start the installer with
1398 * startActivityForResult().
1399 */
1400 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1401 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1402
1403 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001404 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1405 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001406 * data field originated from.
1407 */
rich cannings706e8ba2012-08-20 13:20:14 -07001408 public static final String EXTRA_ORIGINATING_URI
1409 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001410
1411 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001412 * This extra can be used with any Intent used to launch an activity, supplying information
1413 * about who is launching that activity. This field contains a {@link android.net.Uri}
1414 * object, typically an http: or https: URI of the web site that the referral came from;
1415 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1416 * a native application that it came from.
1417 *
1418 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1419 * instead of directly retrieving the extra. It is also valid for applications to
1420 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1421 * a string, not a Uri; the field here, if supplied, will always take precedence,
1422 * however.</p>
1423 *
1424 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001425 */
1426 public static final String EXTRA_REFERRER
1427 = "android.intent.extra.REFERRER";
1428
1429 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001430 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1431 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1432 * not be created, in particular when Intent extras are supplied through the
1433 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1434 * schemes.
1435 *
1436 * @see #EXTRA_REFERRER
1437 */
1438 public static final String EXTRA_REFERRER_NAME
1439 = "android.intent.extra.REFERRER_NAME";
1440
1441 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001442 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1443 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1444 * @hide
1445 */
1446 public static final String EXTRA_ORIGINATING_UID
1447 = "android.intent.extra.ORIGINATING_UID";
1448
1449 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001450 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1451 * package. Tells the installer UI to skip the confirmation with the user
1452 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001453 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1454 * will no longer show an interstitial message about updating existing
1455 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001456 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001457 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001458 public static final String EXTRA_ALLOW_REPLACE
1459 = "android.intent.extra.ALLOW_REPLACE";
1460
1461 /**
1462 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1463 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1464 * return to the application the result code of the install/uninstall. The returned result
1465 * code will be {@link android.app.Activity#RESULT_OK} on success or
1466 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1467 */
1468 public static final String EXTRA_RETURN_RESULT
1469 = "android.intent.extra.RETURN_RESULT";
1470
1471 /**
1472 * Package manager install result code. @hide because result codes are not
1473 * yet ready to be exposed.
1474 */
1475 public static final String EXTRA_INSTALL_RESULT
1476 = "android.intent.extra.INSTALL_RESULT";
1477
1478 /**
1479 * Activity Action: Launch application uninstaller.
1480 * <p>
1481 * Input: The data must be a package: URI whose scheme specific part is
1482 * the package name of the current installed package to be uninstalled.
1483 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1484 * <p>
1485 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1486 * succeeded.
1487 */
1488 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1489 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1490
1491 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001492 * Specify whether the package should be uninstalled for all users.
1493 * @hide because these should not be part of normal application flow.
1494 */
1495 public static final String EXTRA_UNINSTALL_ALL_USERS
1496 = "android.intent.extra.UNINSTALL_ALL_USERS";
1497
1498 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001499 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1500 * describing the last run version of the platform that was setup.
1501 * @hide
1502 */
1503 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1504
Svet Ganov3695b8a2015-03-24 16:30:25 -07001505 /**
1506 * Activity action: Launch UI to manage the permissions of an app.
1507 * <p>
1508 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1509 * will be managed by the launched UI.
1510 * </p>
1511 * <p>
1512 * Output: Nothing.
1513 * </p>
1514 *
1515 * @see #EXTRA_PACKAGE_NAME
1516 *
1517 * @hide
1518 */
1519 @SystemApi
1520 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1521 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1522 "android.intent.action.MANAGE_APP_PERMISSIONS";
1523
1524 /**
1525 * Intent extra: An app package name.
1526 * <p>
1527 * Type: String
1528 * </p>S
1529 *
1530 * @hide
1531 */
1532 @SystemApi
1533 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1534
1535 /**
1536 * Activity action: Launch UI to manage which apps have a given permission.
1537 * <p>
1538 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1539 * to which will be managed by the launched UI.
1540 * </p>
1541 * <p>
1542 * Output: Nothing.
1543 * </p>
1544 *
1545 * @see #EXTRA_PERMISSION_NAME
1546 *
1547 * @hide
1548 */
1549 @SystemApi
1550 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1551 public static final String ACTION_MANAGE_PERMISSION_APPS =
1552 "android.intent.action.MANAGE_PERMISSION_APPS";
1553
1554 /**
1555 * Intent extra: The name of a permission.
1556 * <p>
1557 * Type: String
1558 * </p>
1559 *
1560 * @hide
1561 */
1562 @SystemApi
1563 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1564
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001565 // ---------------------------------------------------------------------
1566 // ---------------------------------------------------------------------
1567 // Standard intent broadcast actions (see action variable).
1568
1569 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001570 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1571 * <p>
1572 * For historical reasons, the name of this broadcast action refers to the power
1573 * state of the screen but it is actually sent in response to changes in the
1574 * overall interactive state of the device.
1575 * </p><p>
1576 * This broadcast is sent when the device becomes non-interactive which may have
1577 * nothing to do with the screen turning off. To determine the
1578 * actual state of the screen, use {@link android.view.Display#getState}.
1579 * </p><p>
1580 * See {@link android.os.PowerManager#isInteractive} for details.
1581 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001582 * You <em>cannot</em> receive this through components declared in
1583 * manifests, only by explicitly registering for it with
1584 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1585 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001586 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001587 * <p class="note">This is a protected intent that can only be sent
1588 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001589 */
1590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1591 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001592
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001593 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001594 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1595 * <p>
1596 * For historical reasons, the name of this broadcast action refers to the power
1597 * state of the screen but it is actually sent in response to changes in the
1598 * overall interactive state of the device.
1599 * </p><p>
1600 * This broadcast is sent when the device becomes interactive which may have
1601 * nothing to do with the screen turning on. To determine the
1602 * actual state of the screen, use {@link android.view.Display#getState}.
1603 * </p><p>
1604 * See {@link android.os.PowerManager#isInteractive} for details.
1605 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001606 * You <em>cannot</em> receive this through components declared in
1607 * manifests, only by explicitly registering for it with
1608 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1609 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001610 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001611 * <p class="note">This is a protected intent that can only be sent
1612 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001613 */
1614 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1615 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001616
1617 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001618 * Broadcast Action: Sent after the system stops dreaming.
1619 *
1620 * <p class="note">This is a protected intent that can only be sent by the system.
1621 * It is only sent to registered receivers.</p>
1622 */
1623 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1624 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1625
1626 /**
1627 * Broadcast Action: Sent after the system starts dreaming.
1628 *
1629 * <p class="note">This is a protected intent that can only be sent by the system.
1630 * It is only sent to registered receivers.</p>
1631 */
1632 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1633 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1634
1635 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001636 * 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 -07001637 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001638 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001639 * <p class="note">This is a protected intent that can only be sent
1640 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001641 */
1642 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001643 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001644
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001645 /**
1646 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001647 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001648 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001649 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1650 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001651 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001652 * <p class="note">This is a protected intent that can only be sent
1653 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001654 */
1655 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1656 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1657 /**
1658 * Broadcast Action: The time was set.
1659 */
1660 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1661 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1662 /**
1663 * Broadcast Action: The date has changed.
1664 */
1665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1666 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1667 /**
1668 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1669 * <ul>
1670 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1671 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001672 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001673 * <p class="note">This is a protected intent that can only be sent
1674 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001675 */
1676 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1677 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1678 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001679 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1680 * DNS entries should be tossed.
1681 * @hide
1682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001686 * Alarm Changed Action: This is broadcast when the AlarmClock
1687 * application's alarm is set or unset. It is used by the
1688 * AlarmClock application and the StatusBar service.
1689 * @hide
1690 */
1691 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1692 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1693 /**
1694 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1695 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1696 * @hide
1697 */
1698 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1699 public static final String ACTION_SYNC_STATE_CHANGED
1700 = "android.intent.action.SYNC_STATE_CHANGED";
1701 /**
1702 * Broadcast Action: This is broadcast once, after the system has finished
1703 * booting. It can be used to perform application-specific initialization,
1704 * such as installing alarms. You must hold the
1705 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1706 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001707 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001708 * <p class="note">This is a protected intent that can only be sent
1709 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001710 */
1711 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1712 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1713 /**
1714 * Broadcast Action: This is broadcast when a user action should request a
1715 * temporary system dialog to dismiss. Some examples of temporary system
1716 * dialogs are the notification window-shade and the recent tasks dialog.
1717 */
1718 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1719 /**
1720 * Broadcast Action: Trigger the download and eventual installation
1721 * of a package.
1722 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001723 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001724 * <p class="note">This is a protected intent that can only be sent
1725 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001726 *
1727 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001728 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001729 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001730 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1731 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1732 /**
1733 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001734 * device. The data contains the name of the package. Note that the
1735 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001736 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001737 * <ul>
1738 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1739 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1740 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1741 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001742 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001743 * <p class="note">This is a protected intent that can only be sent
1744 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001745 */
1746 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1747 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1748 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001749 * Broadcast Action: A new version of an application package has been
1750 * installed, replacing an existing version that was previously installed.
1751 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001752 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001753 * <ul>
1754 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1755 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001756 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001757 * <p class="note">This is a protected intent that can only be sent
1758 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001759 */
1760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1761 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1762 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001763 * Broadcast Action: A new version of your application has been installed
1764 * over an existing one. This is only sent to the application that was
1765 * replaced. It does not contain any additional data; to receive it, just
1766 * use an intent filter for this action.
1767 *
1768 * <p class="note">This is a protected intent that can only be sent
1769 * by the system.
1770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1772 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1773 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001774 * Broadcast Action: An existing application package has been removed from
1775 * the device. The data contains the name of the package. The package
1776 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001777 * <ul>
1778 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1779 * to the package.
1780 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1781 * application -- data and code -- is being removed.
1782 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1783 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1784 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001785 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001786 * <p class="note">This is a protected intent that can only be sent
1787 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001788 */
1789 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1790 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1791 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001792 * Broadcast Action: An existing application package has been completely
1793 * removed from the device. The data contains the name of the package.
1794 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1795 * {@link #EXTRA_DATA_REMOVED} is true and
1796 * {@link #EXTRA_REPLACING} is false of that broadcast.
1797 *
1798 * <ul>
1799 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1800 * to the package.
1801 * </ul>
1802 *
1803 * <p class="note">This is a protected intent that can only be sent
1804 * by the system.
1805 */
1806 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1807 public static final String ACTION_PACKAGE_FULLY_REMOVED
1808 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1809 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001810 * Broadcast Action: An existing application package has been changed (e.g.
1811 * a component has been enabled or disabled). The data contains the name of
1812 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001813 * <ul>
1814 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001815 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001816 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001817 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1818 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001819 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001820 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001821 * <p class="note">This is a protected intent that can only be sent
1822 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001823 */
1824 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1825 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1826 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001827 * @hide
1828 * Broadcast Action: Ask system services if there is any reason to
1829 * restart the given package. The data contains the name of the
1830 * package.
1831 * <ul>
1832 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1833 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1834 * </ul>
1835 *
1836 * <p class="note">This is a protected intent that can only be sent
1837 * by the system.
1838 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08001839 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001840 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1841 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1842 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001843 * Broadcast Action: The user has restarted a package, and all of its
1844 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001846 * be removed. Note that the restarted package does <em>not</em>
1847 * receive this broadcast.
1848 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001849 * <ul>
1850 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1851 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1858 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001859 * Broadcast Action: The user has cleared the data of a package. This should
1860 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001861 * its persistent data is erased and this broadcast sent.
1862 * Note that the cleared package does <em>not</em>
1863 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001864 * <ul>
1865 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1866 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001867 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001868 * <p class="note">This is a protected intent that can only be sent
1869 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001870 */
1871 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1872 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1873 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001874 * Broadcast Action: A user ID has been removed from the system. The user
1875 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001876 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001877 * <p class="note">This is a protected intent that can only be sent
1878 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001879 */
1880 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1881 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001882
1883 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001884 * Broadcast Action: Sent to the installer package of an application
1885 * when that application is first launched (that is the first time it
1886 * is moved out of the stopped state). The data contains the name of the package.
1887 *
1888 * <p class="note">This is a protected intent that can only be sent
1889 * by the system.
1890 */
1891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1892 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1893
1894 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001895 * Broadcast Action: Sent to the system package verifier when a package
1896 * needs to be verified. The data contains the package URI.
1897 * <p class="note">
1898 * This is a protected intent that can only be sent by the system.
1899 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1902 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1903
1904 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001905 * Broadcast Action: Sent to the system package verifier when a package is
1906 * verified. The data contains the package URI.
1907 * <p class="note">
1908 * This is a protected intent that can only be sent by the system.
1909 */
1910 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1911 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1912
1913 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08001914 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
1915 * needs to be verified. The data contains the filter data hosts to be verified against.
1916 * <p class="note">
1917 * This is a protected intent that can only be sent by the system.
1918 * </p>
1919 *
1920 * @hide
1921 */
1922 @SystemApi
1923 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1924 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
1925
1926 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001927 * Broadcast Action: Resources for a set of packages (which were
1928 * previously unavailable) are currently
1929 * available since the media on which they exist is available.
1930 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1931 * list of packages whose availability changed.
1932 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1933 * list of uids of packages whose availability changed.
1934 * Note that the
1935 * packages in this list do <em>not</em> receive this broadcast.
1936 * The specified set of packages are now available on the system.
1937 * <p>Includes the following extras:
1938 * <ul>
1939 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1940 * whose resources(were previously unavailable) are currently available.
1941 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1942 * packages whose resources(were previously unavailable)
1943 * are currently available.
1944 * </ul>
1945 *
1946 * <p class="note">This is a protected intent that can only be sent
1947 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001948 */
1949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001950 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1951 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001952
1953 /**
1954 * Broadcast Action: Resources for a set of packages are currently
1955 * unavailable since the media on which they exist is unavailable.
1956 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1957 * list of packages whose availability changed.
1958 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1959 * list of uids of packages whose availability changed.
1960 * The specified set of packages can no longer be
1961 * launched and are practically unavailable on the system.
1962 * <p>Inclues the following extras:
1963 * <ul>
1964 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1965 * whose resources are no longer available.
1966 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1967 * whose resources are no longer available.
1968 * </ul>
1969 *
1970 * <p class="note">This is a protected intent that can only be sent
1971 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001972 */
1973 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001974 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001975 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001976
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 /**
1978 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001979 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001980 * This should <em>only</em> be used to determine when the wallpaper
1981 * has changed to show the new wallpaper to the user. You should certainly
1982 * never, in response to this, change the wallpaper or other attributes of
1983 * it such as the suggested size. That would be crazy, right? You'd cause
1984 * all kinds of loops, especially if other apps are doing similar things,
1985 * right? Of course. So please don't do this.
1986 *
1987 * @deprecated Modern applications should use
1988 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1989 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1990 * shown behind their UI, rather than watching for this broadcast and
1991 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001993 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001994 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1995 /**
1996 * Broadcast Action: The current device {@link android.content.res.Configuration}
1997 * (orientation, locale, etc) has changed. When such a change happens, the
1998 * UIs (view hierarchy) will need to be rebuilt based on this new
1999 * information; for the most part, applications don't need to worry about
2000 * this, because the system will take care of stopping and restarting the
2001 * application to make sure it sees the new changes. Some system code that
2002 * can not be restarted will need to watch for this action and handle it
2003 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002004 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002005 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002006 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002007 * in manifests, only by explicitly registering for it with
2008 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2009 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002010 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002011 * <p class="note">This is a protected intent that can only be sent
2012 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002013 *
2014 * @see android.content.res.Configuration
2015 */
2016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2017 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2018 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002019 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002020 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002021 * <p class="note">This is a protected intent that can only be sent
2022 * by the system.
2023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2026 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002027 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2028 * charging state, level, and other information about the battery.
2029 * See {@link android.os.BatteryManager} for documentation on the
2030 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002031 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002032 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002033 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002034 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002036 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2037 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2038 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2039 * broadcasts that are sent and can be received through manifest
2040 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002041 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002042 * <p class="note">This is a protected intent that can only be sent
2043 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2047 /**
2048 * Broadcast Action: Indicates low battery condition on the device.
2049 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002050 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002051 * <p class="note">This is a protected intent that can only be sent
2052 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2056 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002057 * Broadcast Action: Indicates the battery is now okay after being low.
2058 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2059 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002060 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002061 * <p class="note">This is a protected intent that can only be sent
2062 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002063 */
2064 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2065 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2066 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002067 * Broadcast Action: External power has been connected to the device.
2068 * This is intended for applications that wish to register specifically to this notification.
2069 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2070 * stay active to receive this notification. This action can be used to implement actions
2071 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002072 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002073 * <p class="note">This is a protected intent that can only be sent
2074 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002075 */
2076 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002077 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002078 /**
2079 * Broadcast Action: External power has been removed from the device.
2080 * This is intended for applications that wish to register specifically to this notification.
2081 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2082 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002083 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002084 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002085 * <p class="note">This is a protected intent that can only be sent
2086 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002087 */
2088 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002089 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002090 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002091 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002092 * Broadcast Action: Device is shutting down.
2093 * This is broadcast when the device is being shut down (completely turned
2094 * off, not sleeping). Once the broadcast is complete, the final shutdown
2095 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002096 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002097 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002098 * <p class="note">This is a protected intent that can only be sent
2099 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002100 * <p>May include the following extras:
2101 * <ul>
2102 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2103 * shutdown is only for userspace processes. If not set, assumed to be false.
2104 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002107 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002108 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002109 * Activity Action: Start this activity to request system shutdown.
2110 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
2111 * to request confirmation from the user before shutting down.
2112 *
2113 * <p class="note">This is a protected intent that can only be sent
2114 * by the system.
2115 *
2116 * {@hide}
2117 */
2118 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2119 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002120 * Broadcast Action: A sticky broadcast that indicates low memory
2121 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002122 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002123 * <p class="note">This is a protected intent that can only be sent
2124 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002125 */
2126 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2127 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2128 /**
2129 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002130 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002131 * <p class="note">This is a protected intent that can only be sent
2132 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2136 /**
Jake Hambybb371632010-08-23 18:16:48 -07002137 * Broadcast Action: A sticky broadcast that indicates a memory full
2138 * condition on the device. This is intended for activities that want
2139 * to be able to fill the data partition completely, leaving only
2140 * enough free space to prevent system-wide SQLite failures.
2141 *
2142 * <p class="note">This is a protected intent that can only be sent
2143 * by the system.
2144 *
2145 * {@hide}
2146 */
2147 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2148 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2149 /**
2150 * Broadcast Action: Indicates memory full condition on the device
2151 * no longer exists.
2152 *
2153 * <p class="note">This is a protected intent that can only be sent
2154 * by the system.
2155 *
2156 * {@hide}
2157 */
2158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2159 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2160 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002161 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2162 * and package management should be started.
2163 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2164 * notification.
2165 */
2166 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2167 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2168 /**
2169 * Broadcast Action: The device has entered USB Mass Storage mode.
2170 * This is used mainly for the USB Settings panel.
2171 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2172 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002173 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002174 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002175 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002176 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2177
2178 /**
2179 * Broadcast Action: The device has exited USB Mass Storage mode.
2180 * This is used mainly for the USB Settings panel.
2181 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2182 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002183 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002184 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002185 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002186 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2187
2188 /**
2189 * Broadcast Action: External media has been removed.
2190 * The path to the mount point for the removed media is contained in the Intent.mData field.
2191 */
2192 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2194
2195 /**
2196 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002197 * 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 -07002198 */
2199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2200 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2201
2202 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002203 * Broadcast Action: External media is present, and being disk-checked
2204 * 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 -08002205 */
2206 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2207 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2208
2209 /**
2210 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2211 * 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 -08002212 */
2213 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2214 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2215
2216 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002217 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002218 * 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 -07002219 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2220 * media was mounted read only.
2221 */
2222 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2223 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2224
2225 /**
2226 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002227 * 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 -07002228 */
2229 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2230 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2231
2232 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002233 * Broadcast Action: External media is no longer being shared via USB mass storage.
2234 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2235 *
2236 * @hide
2237 */
2238 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2239
2240 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002241 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2242 * The path to the mount point for the removed media is contained in the Intent.mData field.
2243 */
2244 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2245 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2246
2247 /**
2248 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002249 * 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 -07002250 */
2251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2252 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2253
2254 /**
2255 * Broadcast Action: User has expressed the desire to remove the external storage media.
2256 * Applications should close all files they have open within the mount point when they receive this intent.
2257 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2258 */
2259 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2260 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2261
2262 /**
2263 * Broadcast Action: The media scanner has started scanning a directory.
2264 * The path to the directory being scanned is contained in the Intent.mData field.
2265 */
2266 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2267 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2268
2269 /**
2270 * Broadcast Action: The media scanner has finished scanning a directory.
2271 * The path to the scanned directory is contained in the Intent.mData field.
2272 */
2273 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2274 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2275
2276 /**
2277 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2278 * The path to the file is contained in the Intent.mData field.
2279 */
2280 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2281 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2282
2283 /**
2284 * Broadcast Action: The "Media Button" was pressed. Includes a single
2285 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2286 * caused the broadcast.
2287 */
2288 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2289 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2290
2291 /**
2292 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2293 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2294 * caused the broadcast.
2295 */
2296 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2297 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2298
2299 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2300 // location; they are not general-purpose actions.
2301
2302 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002303 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 */
2305 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2306 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2307 "android.intent.action.GTALK_CONNECTED";
2308
2309 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002310 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002311 */
2312 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2313 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2314 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002315
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002316 /**
2317 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002318 */
2319 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2320 public static final String ACTION_INPUT_METHOD_CHANGED =
2321 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002322
2323 /**
2324 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2325 * more radios have been turned off or on. The intent will have the following extra value:</p>
2326 * <ul>
2327 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2328 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2329 * turned off</li>
2330 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002331 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002332 * <p class="note">This is a protected intent that can only be sent
2333 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002334 */
2335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2336 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2337
2338 /**
2339 * Broadcast Action: Some content providers have parts of their namespace
2340 * where they publish new events or items that the user may be especially
2341 * interested in. For these things, they may broadcast this action when the
2342 * set of interesting items change.
2343 *
2344 * For example, GmailProvider sends this notification when the set of unread
2345 * mail in the inbox changes.
2346 *
2347 * <p>The data of the intent identifies which part of which provider
2348 * changed. When queried through the content resolver, the data URI will
2349 * return the data set in question.
2350 *
2351 * <p>The intent will have the following extra values:
2352 * <ul>
2353 * <li><em>count</em> - The number of items in the data set. This is the
2354 * same as the number of items in the cursor returned by querying the
2355 * data URI. </li>
2356 * </ul>
2357 *
2358 * This intent will be sent at boot (if the count is non-zero) and when the
2359 * data set changes. It is possible for the data set to change without the
2360 * count changing (for example, if a new unread message arrives in the same
2361 * sync operation in which a message is archived). The phone should still
2362 * ring/vibrate/etc as normal in this case.
2363 */
2364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2365 public static final String ACTION_PROVIDER_CHANGED =
2366 "android.intent.action.PROVIDER_CHANGED";
2367
2368 /**
2369 * Broadcast Action: Wired Headset plugged in or unplugged.
2370 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002371 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2372 * and documentation.
2373 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002374 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002375 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002376 */
2377 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002378 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002379
2380 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002381 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2382 * <ul>
2383 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2384 * </ul>
2385 *
2386 * <p class="note">This is a protected intent that can only be sent
2387 * by the system.
2388 *
2389 * @hide
2390 */
2391 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2392 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2393 = "android.intent.action.ADVANCED_SETTINGS";
2394
2395 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002396 * Broadcast Action: Sent after application restrictions are changed.
2397 *
2398 * <p class="note">This is a protected intent that can only be sent
2399 * by the system.</p>
2400 */
2401 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2402 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2403 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2404
2405 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002406 * Broadcast Action: An outgoing call is about to be placed.
2407 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002408 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002409 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002410 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002411 * the phone number originally intended to be dialed.</li>
2412 * </ul>
2413 * <p>Once the broadcast is finished, the resultData is used as the actual
2414 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002415 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002416 * outgoing call in turn: for example, a parental control application
2417 * might verify that the user is authorized to place the call at that
2418 * time, then a number-rewriting application might add an area code if
2419 * one was not specified.</p>
2420 * <p>For consistency, any receiver whose purpose is to prohibit phone
2421 * calls should have a priority of 0, to ensure it will see the final
2422 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002423 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002424 * should have a positive priority.
2425 * Negative priorities are reserved for the system for this broadcast;
2426 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002427 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2428 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002429 * <p>Emergency calls cannot be intercepted using this mechanism, and
2430 * other calls cannot be modified to call emergency numbers using this
2431 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002432 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2433 * call to use their own service instead. Those apps should first prevent
2434 * the call from being placed by setting resultData to <code>null</code>
2435 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002436 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002437 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2438 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002439 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002440 * <p class="note">This is a protected intent that can only be sent
2441 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002442 */
2443 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2444 public static final String ACTION_NEW_OUTGOING_CALL =
2445 "android.intent.action.NEW_OUTGOING_CALL";
2446
2447 /**
2448 * Broadcast Action: Have the device reboot. This is only for use by
2449 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002450 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002451 * <p class="note">This is a protected intent that can only be sent
2452 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002453 */
2454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2455 public static final String ACTION_REBOOT =
2456 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002457
Wei Huang97ecc9c2009-05-11 17:44:20 -07002458 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002459 * Broadcast Action: A sticky broadcast for changes in the physical
2460 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002461 *
2462 * <p>The intent will have the following extra values:
2463 * <ul>
2464 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002465 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002466 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002467 * <p>This is intended for monitoring the current physical dock state.
2468 * See {@link android.app.UiModeManager} for the normal API dealing with
2469 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002470 */
2471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2472 public static final String ACTION_DOCK_EVENT =
2473 "android.intent.action.DOCK_EVENT";
2474
2475 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002476 * Broadcast Action: A broadcast when idle maintenance can be started.
2477 * This means that the user is not interacting with the device and is
2478 * not expected to do so soon. Typical use of the idle maintenance is
2479 * to perform somehow expensive tasks that can be postponed at a moment
2480 * when they will not degrade user experience.
2481 * <p>
2482 * <p class="note">In order to keep the device responsive in case of an
2483 * unexpected user interaction, implementations of a maintenance task
2484 * should be interruptible. In such a scenario a broadcast with action
2485 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2486 * should not do the maintenance work in
2487 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2488 * maintenance service by {@link Context#startService(Intent)}. Also
2489 * you should hold a wake lock while your maintenance service is running
2490 * to prevent the device going to sleep.
2491 * </p>
2492 * <p>
2493 * <p class="note">This is a protected intent that can only be sent by
2494 * the system.
2495 * </p>
2496 *
2497 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002498 *
2499 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002500 */
2501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2502 public static final String ACTION_IDLE_MAINTENANCE_START =
2503 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2504
2505 /**
2506 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2507 * This means that the user was not interacting with the device as a result
2508 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2509 * was sent and now the user started interacting with the device. Typical
2510 * use of the idle maintenance is to perform somehow expensive tasks that
2511 * can be postponed at a moment when they will not degrade user experience.
2512 * <p>
2513 * <p class="note">In order to keep the device responsive in case of an
2514 * unexpected user interaction, implementations of a maintenance task
2515 * should be interruptible. Hence, on receiving a broadcast with this
2516 * action, the maintenance task should be interrupted as soon as possible.
2517 * In other words, you should not do the maintenance work in
2518 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2519 * maintenance service that was started on receiving of
2520 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2521 * lock you acquired when your maintenance service started.
2522 * </p>
2523 * <p class="note">This is a protected intent that can only be sent
2524 * by the system.
2525 *
2526 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002527 *
2528 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002529 */
2530 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2531 public static final String ACTION_IDLE_MAINTENANCE_END =
2532 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2533
2534 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002535 * Broadcast Action: a remote intent is to be broadcasted.
2536 *
2537 * A remote intent is used for remote RPC between devices. The remote intent
2538 * is serialized and sent from one device to another device. The receiving
2539 * device parses the remote intent and broadcasts it. Note that anyone can
2540 * broadcast a remote intent. However, if the intent receiver of the remote intent
2541 * does not trust intent broadcasts from arbitrary intent senders, it should require
2542 * the sender to hold certain permissions so only trusted sender's broadcast will be
2543 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002544 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002545 */
2546 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002547 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002548
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002549 /**
2550 * Broadcast Action: hook for permforming cleanup after a system update.
2551 *
2552 * The broadcast is sent when the system is booting, before the
2553 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2554 * image. A receiver for this should do its work and then disable itself
2555 * so that it does not get run again at the next boot.
2556 * @hide
2557 */
2558 public static final String ACTION_PRE_BOOT_COMPLETED =
2559 "android.intent.action.PRE_BOOT_COMPLETED";
2560
Amith Yamasani13593602012-03-22 16:16:17 -07002561 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002562 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002563 * on restricted users. The broadcast intent contains an extra
2564 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2565 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2566 * String[] depending on the restriction type.<p/>
2567 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002568 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2569 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2570 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002571 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2572 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002573 * @see RestrictionEntry
2574 */
2575 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2576 "android.intent.action.GET_RESTRICTION_ENTRIES";
2577
2578 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002579 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002580 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002581 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2582 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2583 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002584 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2585 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2586 * challenge.<p/>
2587 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002588 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002589 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002590 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2591 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002592
2593 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002594 * Sent the first time a user is starting, to allow system apps to
2595 * perform one time initialization. (This will not be seen by third
2596 * party applications because a newly initialized user does not have any
2597 * third party applications installed for it.) This is sent early in
2598 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002599 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2600 * broadcast, since it is part of a visible user interaction; be as quick
2601 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002602 */
2603 public static final String ACTION_USER_INITIALIZE =
2604 "android.intent.action.USER_INITIALIZE";
2605
2606 /**
2607 * Sent when a user switch is happening, causing the process's user to be
2608 * brought to the foreground. This is only sent to receivers registered
2609 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2610 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002611 * foreground. This is sent as a foreground
2612 * broadcast, since it is part of a visible user interaction; be as quick
2613 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002614 */
2615 public static final String ACTION_USER_FOREGROUND =
2616 "android.intent.action.USER_FOREGROUND";
2617
2618 /**
2619 * Sent when a user switch is happening, causing the process's user to be
2620 * sent to the background. This is only sent to receivers registered
2621 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2622 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002623 * background. This is sent as a foreground
2624 * broadcast, since it is part of a visible user interaction; be as quick
2625 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002626 */
2627 public static final String ACTION_USER_BACKGROUND =
2628 "android.intent.action.USER_BACKGROUND";
2629
2630 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002631 * Broadcast sent to the system when a user is added. Carries an extra
2632 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2633 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002634 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002635 * @hide
2636 */
2637 public static final String ACTION_USER_ADDED =
2638 "android.intent.action.USER_ADDED";
2639
2640 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002641 * Broadcast sent by the system when a user is started. Carries an extra
2642 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002643 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002644 * that has been started. This is sent as a foreground
2645 * broadcast, since it is part of a visible user interaction; be as quick
2646 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002647 * @hide
2648 */
2649 public static final String ACTION_USER_STARTED =
2650 "android.intent.action.USER_STARTED";
2651
2652 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002653 * Broadcast sent when a user is in the process of starting. Carries an extra
2654 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2655 * sent to registered receivers, not manifest receivers. It is sent to all
2656 * users (including the one that is being started). You must hold
2657 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2658 * this broadcast. This is sent as a background broadcast, since
2659 * its result is not part of the primary UX flow; to safely keep track of
2660 * started/stopped state of a user you can use this in conjunction with
2661 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2662 * other user state broadcasts since those are foreground broadcasts so can
2663 * execute in a different order.
2664 * @hide
2665 */
2666 public static final String ACTION_USER_STARTING =
2667 "android.intent.action.USER_STARTING";
2668
2669 /**
2670 * Broadcast sent when a user is going to be stopped. Carries an extra
2671 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2672 * sent to registered receivers, not manifest receivers. It is sent to all
2673 * users (including the one that is being stopped). You must hold
2674 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2675 * this broadcast. The user will not stop until all receivers have
2676 * handled the broadcast. This is sent as a background broadcast, since
2677 * its result is not part of the primary UX flow; to safely keep track of
2678 * started/stopped state of a user you can use this in conjunction with
2679 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2680 * other user state broadcasts since those are foreground broadcasts so can
2681 * execute in a different order.
2682 * @hide
2683 */
2684 public static final String ACTION_USER_STOPPING =
2685 "android.intent.action.USER_STOPPING";
2686
2687 /**
2688 * Broadcast sent to the system when a user is stopped. Carries an extra
2689 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2690 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2691 * specific package. This is only sent to registered receivers, not manifest
2692 * receivers. It is sent to all running users <em>except</em> the one that
2693 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002694 * @hide
2695 */
2696 public static final String ACTION_USER_STOPPED =
2697 "android.intent.action.USER_STOPPED";
2698
2699 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002700 * 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 -07002701 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002702 * one that has been removed. The user will not be completely removed until all receivers have
2703 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002704 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002705 * @hide
2706 */
2707 public static final String ACTION_USER_REMOVED =
2708 "android.intent.action.USER_REMOVED";
2709
2710 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002711 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002712 * the userHandle of the user to become the current one. This is only sent to
2713 * registered receivers, not manifest receivers. It is sent to all running users.
2714 * You must hold
2715 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002716 * @hide
2717 */
2718 public static final String ACTION_USER_SWITCHED =
2719 "android.intent.action.USER_SWITCHED";
2720
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002721 /**
2722 * Broadcast sent to the system when a user's information changes. Carries an extra
2723 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002724 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002725 * @hide
2726 */
2727 public static final String ACTION_USER_INFO_CHANGED =
2728 "android.intent.action.USER_INFO_CHANGED";
2729
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002730 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002731 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2732 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002733 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2734 * that need to display merged content across both primary and managed profiles need to
2735 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002736 * not manifest receivers.
2737 */
2738 public static final String ACTION_MANAGED_PROFILE_ADDED =
2739 "android.intent.action.MANAGED_PROFILE_ADDED";
2740
2741 /**
2742 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002743 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2744 * Only applications (for example Launchers) that need to display merged content across both
2745 * primary and managed profiles need to worry about this broadcast. This is only sent to
2746 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002747 */
2748 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2749 "android.intent.action.MANAGED_PROFILE_REMOVED";
2750
2751 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002752 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2753 */
2754 public static final String ACTION_QUICK_CLOCK =
2755 "android.intent.action.QUICK_CLOCK";
2756
Michael Wright0087a142013-02-05 16:29:39 -08002757 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002758 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002759 * @hide
2760 */
2761 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2762 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2763
Justin Kohd378ad72013-04-01 12:18:26 -07002764 /**
2765 * Broadcast Action: A global button was pressed. Includes a single
2766 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2767 * caused the broadcast.
2768 * @hide
2769 */
2770 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2771
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002772 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002773 * Activity Action: Allow the user to select and return one or more existing
2774 * documents. When invoked, the system will display the various
2775 * {@link DocumentsProvider} instances installed on the device, letting the
2776 * user interactively navigate through them. These documents include local
2777 * media, such as photos and video, and documents provided by installed
2778 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002779 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002780 * Each document is represented as a {@code content://} URI backed by a
2781 * {@link DocumentsProvider}, which can be opened as a stream with
2782 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2783 * {@link android.provider.DocumentsContract.Document} metadata.
2784 * <p>
2785 * All selected documents are returned to the calling application with
2786 * persistable read and write permission grants. If you want to maintain
2787 * access to the documents across device reboots, you need to explicitly
2788 * take the persistable permissions using
2789 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2790 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002791 * Callers must indicate the acceptable document MIME types through
2792 * {@link #setType(String)}. For example, to select photos, use
2793 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2794 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2795 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002796 * <p>
2797 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002798 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2799 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002800 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002801 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2802 * returned URIs can be opened with
2803 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002804 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002805 * Output: The URI of the item that was picked, returned in
2806 * {@link #getData()}. This must be a {@code content://} URI so that any
2807 * receiver can access it. If multiple documents were selected, they are
2808 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002809 *
2810 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002811 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002812 * @see #ACTION_CREATE_DOCUMENT
2813 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002814 */
2815 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2816 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2817
2818 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002819 * Activity Action: Allow the user to create a new document. When invoked,
2820 * the system will display the various {@link DocumentsProvider} instances
2821 * installed on the device, letting the user navigate through them. The
2822 * returned document may be a newly created document with no content, or it
2823 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002824 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002825 * Each document is represented as a {@code content://} URI backed by a
2826 * {@link DocumentsProvider}, which can be opened as a stream with
2827 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2828 * {@link android.provider.DocumentsContract.Document} metadata.
2829 * <p>
2830 * Callers must indicate the concrete MIME type of the document being
2831 * created by setting {@link #setType(String)}. This MIME type cannot be
2832 * changed after the document is created.
2833 * <p>
2834 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2835 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002836 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002837 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2838 * returned URIs can be opened with
2839 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002840 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002841 * Output: The URI of the item that was created. This must be a
2842 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002843 *
2844 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002845 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002846 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002847 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002848 */
2849 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2850 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2851
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002852 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002853 * Activity Action: Allow the user to pick a directory subtree. When
2854 * invoked, the system will display the various {@link DocumentsProvider}
2855 * instances installed on the device, letting the user navigate through
2856 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002857 * <p>
2858 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002859 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2860 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2861 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002862 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002863 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002864 *
2865 * @see DocumentsContract
2866 */
2867 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002868 public static final String
2869 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002870
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002871 /** {@hide} */
2872 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2873
Christopher Tate6597e342015-02-17 12:15:25 -08002874 /**
2875 * Broadcast action: report that a settings element is being restored from backup. The intent
2876 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
2877 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
2878 * is the value of that settings entry prior to the restore operation. All of these values are
2879 * represented as strings.
2880 *
2881 * <p>This broadcast is sent only for settings provider entries known to require special handling
2882 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
2883 * the provider's backup agent implementation.
2884 *
2885 * @see #EXTRA_SETTING_NAME
2886 * @see #EXTRA_SETTING_PREVIOUS_VALUE
2887 * @see #EXTRA_SETTING_NEW_VALUE
2888 * {@hide}
2889 */
2890 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
2891
2892 /** {@hide} */
2893 public static final String EXTRA_SETTING_NAME = "setting_name";
2894 /** {@hide} */
2895 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
2896 /** {@hide} */
2897 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
2898
Clara Bayarri0a26157a2015-03-26 18:38:55 +00002899 /**
2900 * Activity Action: Process a piece of text.
2901 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
2902 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
2903 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
2904 */
2905 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2906 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
2907 /**
2908 * The name of the extra used to define the text to be processed.
2909 */
2910 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
2911 /**
2912 * The name of the extra used to define if the processed text will be used as read-only.
2913 */
2914 public static final String EXTRA_PROCESS_TEXT_READONLY =
2915 "android.intent.extra.PROCESS_TEXT_READONLY";
2916
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002917 // ---------------------------------------------------------------------
2918 // ---------------------------------------------------------------------
2919 // Standard intent categories (see addCategory()).
2920
2921 /**
2922 * Set if the activity should be an option for the default action
2923 * (center press) to perform on a piece of data. Setting this will
2924 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002925 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002926 * Intent when initiating an action -- it is for use in intent filters
2927 * specified in packages.
2928 */
2929 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2930 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2931 /**
2932 * Activities that can be safely invoked from a browser must support this
2933 * category. For example, if the user is viewing a web page or an e-mail
2934 * and clicks on a link in the text, the Intent generated execute that
2935 * link will require the BROWSABLE category, so that only activities
2936 * supporting this category will be considered as possible actions. By
2937 * supporting this category, you are promising that there is nothing
2938 * damaging (without user intervention) that can happen by invoking any
2939 * matching Intent.
2940 */
2941 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2942 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2943 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002944 * Categories for activities that can participate in voice interaction.
2945 * An activity that supports this category must be prepared to run with
2946 * no UI shown at all (though in some case it may have a UI shown), and
2947 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2948 */
2949 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2950 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2951 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002952 * Set if the activity should be considered as an alternative action to
2953 * the data the user is currently viewing. See also
2954 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2955 * applies to the selection in a list of items.
2956 *
2957 * <p>Supporting this category means that you would like your activity to be
2958 * displayed in the set of alternative things the user can do, usually as
2959 * part of the current activity's options menu. You will usually want to
2960 * include a specific label in the &lt;intent-filter&gt; of this action
2961 * describing to the user what it does.
2962 *
2963 * <p>The action of IntentFilter with this category is important in that it
2964 * describes the specific action the target will perform. This generally
2965 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2966 * a specific name such as "com.android.camera.action.CROP. Only one
2967 * alternative of any particular action will be shown to the user, so using
2968 * a specific action like this makes sure that your alternative will be
2969 * displayed while also allowing other applications to provide their own
2970 * overrides of that particular action.
2971 */
2972 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2973 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2974 /**
2975 * Set if the activity should be considered as an alternative selection
2976 * action to the data the user has currently selected. This is like
2977 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2978 * of items from which the user can select, giving them alternatives to the
2979 * default action that will be performed on it.
2980 */
2981 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2982 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2983 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002984 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002985 */
2986 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2987 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2988 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002989 * Should be displayed in the top-level launcher.
2990 */
2991 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2992 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2993 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002994 * Indicates an activity optimized for Leanback mode, and that should
2995 * be displayed in the Leanback launcher.
2996 */
2997 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2998 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2999 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003000 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3001 * @hide
3002 */
3003 @SystemApi
3004 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3005 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003006 * Provides information about the package it is in; typically used if
3007 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3008 * a front-door to the user without having to be shown in the all apps list.
3009 */
3010 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3011 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3012 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003013 * This is the home activity, that is the first activity that is displayed
3014 * when the device boots.
3015 */
3016 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3017 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3018 /**
3019 * This activity is a preference panel.
3020 */
3021 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3022 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3023 /**
3024 * This activity is a development preference panel.
3025 */
3026 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3027 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3028 /**
3029 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003030 */
3031 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3032 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3033 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003034 * This activity allows the user to browse and download new applications.
3035 */
3036 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3037 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3038 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003039 * This activity may be exercised by the monkey or other automated test tools.
3040 */
3041 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3042 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3043 /**
3044 * To be used as a test (not part of the normal user experience).
3045 */
3046 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3047 /**
3048 * To be used as a unit test (run through the Test Harness).
3049 */
3050 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3051 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003052 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003053 * experience).
3054 */
3055 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003056
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003057 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003058 * Used to indicate that an intent only wants URIs that can be opened with
3059 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3060 * must support at least the columns defined in {@link OpenableColumns} when
3061 * queried.
3062 *
3063 * @see #ACTION_GET_CONTENT
3064 * @see #ACTION_OPEN_DOCUMENT
3065 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003066 */
3067 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3068 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3069
3070 /**
3071 * To be used as code under test for framework instrumentation tests.
3072 */
3073 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3074 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003075 /**
3076 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003077 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3078 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003079 */
3080 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3081 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3082 /**
3083 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003084 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3085 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003086 */
3087 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3088 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003089 /**
3090 * An activity to run when device is inserted into a analog (low end) dock.
3091 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3092 * information, see {@link android.app.UiModeManager}.
3093 */
3094 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3095 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3096
3097 /**
3098 * An activity to run when device is inserted into a digital (high end) dock.
3099 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3100 * information, see {@link android.app.UiModeManager}.
3101 */
3102 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3103 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003104
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003105 /**
3106 * Used to indicate that the activity can be used in a car environment.
3107 */
3108 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3109 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3110
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003111 // ---------------------------------------------------------------------
3112 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003113 // Application launch intent categories (see addCategory()).
3114
3115 /**
3116 * Used with {@link #ACTION_MAIN} to launch the browser application.
3117 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003118 * <p>NOTE: This should not be used as the primary key of an Intent,
3119 * since it will not result in the app launching with the correct
3120 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003121 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003122 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003123 */
3124 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3125 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3126
3127 /**
3128 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3129 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003130 * <p>NOTE: This should not be used as the primary key of an Intent,
3131 * since it will not result in the app launching with the correct
3132 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003133 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003134 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003135 */
3136 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3137 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3138
3139 /**
3140 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3141 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003142 * <p>NOTE: This should not be used as the primary key of an Intent,
3143 * since it will not result in the app launching with the correct
3144 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003145 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003146 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003147 */
3148 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3149 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3150
3151 /**
3152 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3153 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003154 * <p>NOTE: This should not be used as the primary key of an Intent,
3155 * since it will not result in the app launching with the correct
3156 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003157 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003158 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003159 */
3160 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3161 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3162
3163 /**
3164 * Used with {@link #ACTION_MAIN} to launch the email application.
3165 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003166 * <p>NOTE: This should not be used as the primary key of an Intent,
3167 * since it will not result in the app launching with the correct
3168 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003169 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003170 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003171 */
3172 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3173 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3174
3175 /**
3176 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3177 * The activity should be able to view and manipulate image and video files
3178 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003179 * <p>NOTE: This should not be used as the primary key of an Intent,
3180 * since it will not result in the app launching with the correct
3181 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003182 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003183 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003184 */
3185 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3186 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3187
3188 /**
3189 * Used with {@link #ACTION_MAIN} to launch the maps application.
3190 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003191 * <p>NOTE: This should not be used as the primary key of an Intent,
3192 * since it will not result in the app launching with the correct
3193 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003194 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003195 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003196 */
3197 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3198 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3199
3200 /**
3201 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3202 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003203 * <p>NOTE: This should not be used as the primary key of an Intent,
3204 * since it will not result in the app launching with the correct
3205 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003206 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003207 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003208 */
3209 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3210 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3211
3212 /**
3213 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003214 * The activity should be able to play, browse, or manipulate music files
3215 * stored on the device.
3216 * <p>NOTE: This should not be used as the primary key of an Intent,
3217 * since it will not result in the app launching with the correct
3218 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003219 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003220 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003221 */
3222 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3223 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3224
3225 // ---------------------------------------------------------------------
3226 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003227 // Standard extra data keys.
3228
3229 /**
3230 * The initial data to place in a newly created record. Use with
3231 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3232 * fields as would be given to the underlying ContentProvider.insert()
3233 * call.
3234 */
3235 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3236
3237 /**
3238 * A constant CharSequence that is associated with the Intent, used with
3239 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3240 * this may be a styled CharSequence, so you must use
3241 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3242 * retrieve it.
3243 */
3244 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3245
3246 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003247 * A constant String that is associated with the Intent, used with
3248 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3249 * as HTML formatted text. Note that you <em>must</em> also supply
3250 * {@link #EXTRA_TEXT}.
3251 */
3252 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3253
3254 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003255 * A content: URI holding a stream of data associated with the Intent,
3256 * used with {@link #ACTION_SEND} to supply the data being sent.
3257 */
3258 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3259
3260 /**
3261 * A String[] holding e-mail addresses that should be delivered to.
3262 */
3263 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3264
3265 /**
3266 * A String[] holding e-mail addresses that should be carbon copied.
3267 */
3268 public static final String EXTRA_CC = "android.intent.extra.CC";
3269
3270 /**
3271 * A String[] holding e-mail addresses that should be blind carbon copied.
3272 */
3273 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3274
3275 /**
3276 * A constant string holding the desired subject line of a message.
3277 */
3278 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3279
3280 /**
3281 * An Intent describing the choices you would like shown with
3282 * {@link #ACTION_PICK_ACTIVITY}.
3283 */
3284 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3285
3286 /**
3287 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003288 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003289 */
3290 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3291
3292 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003293 * A Parcelable[] of {@link Intent} or
3294 * {@link android.content.pm.LabeledIntent} objects as set with
3295 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3296 * a the front of the list of choices, when shown to the user with a
3297 * {@link #ACTION_CHOOSER}.
3298 */
3299 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3300
3301 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003302 * A Bundle forming a mapping of potential target package names to different extras Bundles
3303 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3304 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3305 * be currently installed on the device.
3306 *
3307 * <p>An application may choose to provide alternate extras for the case where a user
3308 * selects an activity from a predetermined set of target packages. If the activity
3309 * the user selects from the chooser belongs to a package with its package name as
3310 * a key in this bundle, the corresponding extras for that package will be merged with
3311 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3312 * extra has the same key as an extra already present in the intent it will overwrite
3313 * the extra from the intent.</p>
3314 *
3315 * <p><em>Examples:</em>
3316 * <ul>
3317 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3318 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3319 * parameters for that target.</li>
3320 * <li>An application may offer additional metadata for known targets of a given intent
3321 * to pass along information only relevant to that target such as account or content
3322 * identifiers already known to that application.</li>
3323 * </ul></p>
3324 */
3325 public static final String EXTRA_REPLACEMENT_EXTRAS =
3326 "android.intent.extra.REPLACEMENT_EXTRAS";
3327
3328 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003329 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3330 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3331 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3332 * {@link ComponentName} of the chosen component.
3333 *
3334 * <p>In some situations this callback may never come, for example if the user abandons
3335 * the chooser, switches to another task or any number of other reasons. Apps should not
3336 * be written assuming that this callback will always occur.</p>
3337 */
3338 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3339 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3340
3341 /**
3342 * The {@link ComponentName} chosen by the user to complete an action.
3343 *
3344 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3345 */
3346 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3347
3348 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003349 * A {@link android.view.KeyEvent} object containing the event that
3350 * triggered the creation of the Intent it is in.
3351 */
3352 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3353
3354 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003355 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3356 * before shutting down.
3357 *
3358 * {@hide}
3359 */
3360 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3361
3362 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003363 * 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 -07003364 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3365 * of restarting the application.
3366 */
3367 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3368
3369 /**
3370 * A String holding the phone number originally entered in
3371 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3372 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3373 */
3374 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003375
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003376 /**
3377 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3378 * intents to supply the uid the package had been assigned. Also an optional
3379 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3380 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3381 * purpose.
3382 */
3383 public static final String EXTRA_UID = "android.intent.extra.UID";
3384
3385 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003386 * @hide String array of package names.
3387 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003388 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003389 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3390
3391 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003392 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3393 * intents to indicate whether this represents a full uninstall (removing
3394 * both the code and its data) or a partial uninstall (leaving its data,
3395 * implying that this is an update).
3396 */
3397 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003398
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003399 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003400 * @hide
3401 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3402 * intents to indicate that at this point the package has been removed for
3403 * all users on the device.
3404 */
3405 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3406 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3407
3408 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003409 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3410 * intents to indicate that this is a replacement of the package, so this
3411 * broadcast will immediately be followed by an add broadcast for a
3412 * different version of the same package.
3413 */
3414 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003415
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003416 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417 * Used as an int extra field in {@link android.app.AlarmManager} intents
3418 * to tell the application being invoked how many pending alarms are being
3419 * delievered with the intent. For one-shot alarms this will always be 1.
3420 * For recurring alarms, this might be greater than 1 if the device was
3421 * asleep or powered off at the time an earlier alarm would have been
3422 * delivered.
3423 */
3424 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003425
Jacek Surazski86b6c532009-05-13 14:38:28 +02003426 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003427 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3428 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003429 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3430 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003431 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3432 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3433 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003434 */
3435 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3436
3437 /**
3438 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3439 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003440 */
3441 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3442
3443 /**
3444 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3445 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003446 */
3447 public static final int EXTRA_DOCK_STATE_DESK = 1;
3448
3449 /**
3450 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3451 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003452 */
3453 public static final int EXTRA_DOCK_STATE_CAR = 2;
3454
3455 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003456 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3457 * to represent that the phone is in a analog (low end) dock.
3458 */
3459 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3460
3461 /**
3462 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3463 * to represent that the phone is in a digital (high end) dock.
3464 */
3465 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3466
3467 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003468 * Boolean that can be supplied as meta-data with a dock activity, to
3469 * indicate that the dock should take over the home key when it is active.
3470 */
3471 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003472
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003473 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003474 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3475 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003476 */
3477 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3478
3479 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003480 * Used in the extra field in the remote intent. It's astring token passed with the
3481 * remote intent.
3482 */
3483 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3484 "android.intent.extra.remote_intent_token";
3485
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003486 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003487 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003488 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003489 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003490 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003491 "android.intent.extra.changed_component_name";
3492
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003493 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003494 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003495 * and contains a string array of all of the components that have changed. If
3496 * the state of the overall package has changed, then it will contain an entry
3497 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003498 */
3499 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3500 "android.intent.extra.changed_component_name_list";
3501
3502 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003503 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003504 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3505 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003506 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003507 */
3508 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3509 "android.intent.extra.changed_package_list";
3510
3511 /**
3512 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003513 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3514 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003515 * and contains an integer array of uids of all of the components
3516 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003517 */
3518 public static final String EXTRA_CHANGED_UID_LIST =
3519 "android.intent.extra.changed_uid_list";
3520
3521 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003522 * @hide
3523 * Magic extra system code can use when binding, to give a label for
3524 * who it is that has bound to a service. This is an integer giving
3525 * a framework string resource that can be displayed to the user.
3526 */
3527 public static final String EXTRA_CLIENT_LABEL =
3528 "android.intent.extra.client_label";
3529
3530 /**
3531 * @hide
3532 * Magic extra system code can use when binding, to give a PendingIntent object
3533 * that can be launched for the user to disable the system's use of this
3534 * service.
3535 */
3536 public static final String EXTRA_CLIENT_INTENT =
3537 "android.intent.extra.client_intent";
3538
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003539 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003540 * Extra used to indicate that an intent should only return data that is on
3541 * the local device. This is a boolean extra; the default is false. If true,
3542 * an implementation should only allow the user to select data that is
3543 * already on the device, not requiring it be downloaded from a remote
3544 * service when opened.
3545 *
3546 * @see #ACTION_GET_CONTENT
3547 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003548 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003549 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003550 */
3551 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003552 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003553
Amith Yamasani13593602012-03-22 16:16:17 -07003554 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003555 * Extra used to indicate that an intent can allow the user to select and
3556 * return multiple items. This is a boolean extra; the default is false. If
3557 * true, an implementation is allowed to present the user with a UI where
3558 * they can pick multiple items that are all returned to the caller. When
3559 * this happens, they should be returned as the {@link #getClipData()} part
3560 * of the result Intent.
3561 *
3562 * @see #ACTION_GET_CONTENT
3563 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003564 */
3565 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003566 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003567
3568 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003569 * The integer userHandle carried with broadcast intents related to addition, removal and
3570 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3571 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3572 *
Amith Yamasani13593602012-03-22 16:16:17 -07003573 * @hide
3574 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003575 public static final String EXTRA_USER_HANDLE =
3576 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003577
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003578 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003579 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3580 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3581 */
3582 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003583 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003584
3585 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003586 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003587 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3588 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003589 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003590 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3591
3592 /**
3593 * Extra sent in the intent to the BroadcastReceiver that handles
3594 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3595 * the restrictions as key/value pairs.
3596 */
3597 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3598 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003599
Amith Yamasani86118ba2013-03-28 14:33:16 -07003600 /**
3601 * Extra used in the response from a BroadcastReceiver that handles
3602 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3603 */
3604 public static final String EXTRA_RESTRICTIONS_INTENT =
3605 "android.intent.extra.restrictions_intent";
3606
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003607 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003608 * Extra used to communicate a set of acceptable MIME types. The type of the
3609 * extra is {@code String[]}. Values may be a combination of concrete MIME
3610 * types (such as "image/png") and/or partial MIME types (such as
3611 * "audio/*").
3612 *
3613 * @see #ACTION_GET_CONTENT
3614 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003615 */
3616 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3617
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003618 /**
3619 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3620 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003621 * When this is true, hardware devices can use this information to determine that
3622 * they shouldn't do a complete shutdown of their device since this is not a
3623 * complete shutdown down to the kernel, but only user space restarting.
3624 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003625 */
3626 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3627 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3628
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003629 /**
3630 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3631 * user has set their time format preferences to the 24 hour format.
3632 *
3633 * @hide for internal use only.
3634 */
3635 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3636 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3637
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003638 /** {@hide} */
3639 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003641 // ---------------------------------------------------------------------
3642 // ---------------------------------------------------------------------
3643 // Intent flags (see mFlags variable).
3644
Tor Norbyed9273d62013-05-30 15:59:53 -07003645 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003646 @IntDef(flag = true, value = {
3647 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3648 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003649 @Retention(RetentionPolicy.SOURCE)
3650 public @interface GrantUriMode {}
3651
Jeff Sharkey846318a2014-04-04 12:12:41 -07003652 /** @hide */
3653 @IntDef(flag = true, value = {
3654 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3655 @Retention(RetentionPolicy.SOURCE)
3656 public @interface AccessUriMode {}
3657
3658 /**
3659 * Test if given mode flags specify an access mode, which must be at least
3660 * read and/or write.
3661 *
3662 * @hide
3663 */
3664 public static boolean isAccessUriMode(int modeFlags) {
3665 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3666 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3667 }
3668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003669 /**
3670 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003671 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003672 * specified in its ClipData. When applying to an Intent's ClipData,
3673 * all URIs as well as recursive traversals through data or other ClipData
3674 * in Intent items will be granted; only the grant flags of the top-level
3675 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003676 */
3677 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3678 /**
3679 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003680 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003681 * specified in its ClipData. When applying to an Intent's ClipData,
3682 * all URIs as well as recursive traversals through data or other ClipData
3683 * in Intent items will be granted; only the grant flags of the top-level
3684 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003685 */
3686 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3687 /**
3688 * Can be set by the caller to indicate that this Intent is coming from
3689 * a background operation, not from direct user interaction.
3690 */
3691 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3692 /**
3693 * A flag you can enable for debugging: when set, log messages will be
3694 * printed during the resolution of this intent to show you what has
3695 * been found to create the final resolved list.
3696 */
3697 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003698 /**
3699 * If set, this intent will not match any components in packages that
3700 * are currently stopped. If this is not set, then the default behavior
3701 * is to include such applications in the result.
3702 */
3703 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3704 /**
3705 * If set, this intent will always match any components in packages that
3706 * are currently stopped. This is the default behavior when
3707 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3708 * flags are set, this one wins (it allows overriding of exclude for
3709 * places where the framework may automatically set the exclude flag).
3710 */
3711 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003712
3713 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003714 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003715 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003716 * persisted across device reboots until explicitly revoked with
3717 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3718 * grant for possible persisting; the receiving application must call
3719 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3720 * actually persist.
3721 *
3722 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3723 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3724 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003725 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003726 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003727 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003728
3729 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003730 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3731 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3732 * applies to any URI that is a prefix match against the original granted
3733 * URI. (Without this flag, the URI must match exactly for access to be
3734 * granted.) Another URI is considered a prefix match only when scheme,
3735 * authority, and all path segments defined by the prefix are an exact
3736 * match.
3737 */
3738 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3739
3740 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003741 * If set, the new activity is not kept in the history stack. As soon as
3742 * the user navigates away from it, the activity is finished. This may also
3743 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3744 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07003745 *
3746 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
3747 * is never invoked when the current activity starts a new activity which
3748 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003749 */
3750 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3751 /**
3752 * If set, the activity will not be launched if it is already running
3753 * at the top of the history stack.
3754 */
3755 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3756 /**
3757 * If set, this activity will become the start of a new task on this
3758 * history stack. A task (from the activity that started it to the
3759 * next task activity) defines an atomic group of activities that the
3760 * user can move to. Tasks can be moved to the foreground and background;
3761 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003762 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003763 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3764 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003765 *
3766 * <p>This flag is generally used by activities that want
3767 * to present a "launcher" style behavior: they give the user a list of
3768 * separate things that can be done, which otherwise run completely
3769 * independently of the activity launching them.
3770 *
3771 * <p>When using this flag, if a task is already running for the activity
3772 * you are now starting, then a new activity will not be started; instead,
3773 * the current task will simply be brought to the front of the screen with
3774 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3775 * to disable this behavior.
3776 *
3777 * <p>This flag can not be used when the caller is requesting a result from
3778 * the activity being launched.
3779 */
3780 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3781 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003782 * This flag is used to create a new task and launch an activity into it.
3783 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3784 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3785 * search through existing tasks for ones matching this Intent. Only if no such
3786 * task is found would a new task be created. When paired with
3787 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3788 * the search for a matching task and unconditionally start a new task.
3789 *
3790 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3791 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003792 * top-level application launcher.</strong> Used in conjunction with
3793 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3794 * behavior of bringing an existing task to the foreground. When set,
3795 * a new task is <em>always</em> started to host the Activity for the
3796 * Intent, regardless of whether there is already an existing task running
3797 * the same thing.
3798 *
3799 * <p><strong>Because the default system does not include graphical task management,
3800 * you should not use this flag unless you provide some way for a user to
3801 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003802 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003803 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3804 * creating new document tasks.
3805 *
3806 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003807 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003808 *
Scott Main7aee61f2011-02-08 11:25:01 -08003809 * <p>See
3810 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3811 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003812 *
3813 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3814 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003815 */
3816 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3817 /**
3818 * If set, and the activity being launched is already running in the
3819 * current task, then instead of launching a new instance of that activity,
3820 * all of the other activities on top of it will be closed and this Intent
3821 * will be delivered to the (now on top) old activity as a new Intent.
3822 *
3823 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3824 * If D calls startActivity() with an Intent that resolves to the component
3825 * of activity B, then C and D will be finished and B receive the given
3826 * Intent, resulting in the stack now being: A, B.
3827 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003828 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003829 * either receive the new intent you are starting here in its
3830 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003831 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003832 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3833 * the same intent, then it will be finished and re-created; for all other
3834 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3835 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003836 *
3837 * <p>This launch mode can also be used to good effect in conjunction with
3838 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3839 * of a task, it will bring any currently running instance of that task
3840 * to the foreground, and then clear it to its root state. This is
3841 * especially useful, for example, when launching an activity from the
3842 * notification manager.
3843 *
Scott Main7aee61f2011-02-08 11:25:01 -08003844 * <p>See
3845 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3846 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847 */
3848 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3849 /**
3850 * If set and this intent is being used to launch a new activity from an
3851 * existing one, then the reply target of the existing activity will be
3852 * transfered to the new activity. This way the new activity can call
3853 * {@link android.app.Activity#setResult} and have that result sent back to
3854 * the reply target of the original activity.
3855 */
3856 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3857 /**
3858 * If set and this intent is being used to launch a new activity from an
3859 * existing one, the current activity will not be counted as the top
3860 * activity for deciding whether the new intent should be delivered to
3861 * the top instead of starting a new one. The previous activity will
3862 * be used as the top, with the assumption being that the current activity
3863 * will finish itself immediately.
3864 */
3865 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3866 /**
3867 * If set, the new activity is not kept in the list of recently launched
3868 * activities.
3869 */
3870 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3871 /**
3872 * This flag is not normally set by application code, but set for you by
3873 * the system as described in the
3874 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3875 * launchMode} documentation for the singleTask mode.
3876 */
3877 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3878 /**
3879 * If set, and this activity is either being started in a new task or
3880 * bringing to the top an existing task, then it will be launched as
3881 * the front door of the task. This will result in the application of
3882 * any affinities needed to have that task in the proper state (either
3883 * moving activities to or from it), or simply resetting that task to
3884 * its initial state if needed.
3885 */
3886 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3887 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003888 * This flag is not normally set by application code, but set for you by
3889 * the system if this activity is being launched from history
3890 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003891 */
3892 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003893 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003894 * @deprecated As of API 21 this performs identically to
3895 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003896 */
3897 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003898 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003899 * This flag is used to open a document into a new task rooted at the activity launched
3900 * by this Intent. Through the use of this flag, or its equivalent attribute,
3901 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00003902 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003903 *
Craig Mautner026596b2014-05-21 15:35:44 -07003904 * <p>The use of the activity attribute form of this,
3905 * {@link android.R.attr#documentLaunchMode}, is
3906 * preferred over the Intent flag described here. The attribute form allows the
3907 * Activity to specify multiple document behavior for all launchers of the Activity
3908 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003909 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003910 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3911 * it is kept after the activity is finished is different than the use of
3912 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3913 * this flag is being used to create a new recents entry, then by default that entry
3914 * will be removed once the activity is finished. You can modify this behavior with
3915 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3916 *
Craig Mautner026596b2014-05-21 15:35:44 -07003917 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3918 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3919 * equivalent of the Activity manifest specifying {@link
3920 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3921 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3922 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003923 *
Craig Mautner026596b2014-05-21 15:35:44 -07003924 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003925 *
Craig Mautner026596b2014-05-21 15:35:44 -07003926 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003927 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3928 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003929 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003930 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003931 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003932 * callback from occurring on the current frontmost activity before it is
3933 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003934 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003935 * <p>Typically, an activity can rely on that callback to indicate that an
3936 * explicit user action has caused their activity to be moved out of the
3937 * foreground. The callback marks an appropriate point in the activity's
3938 * lifecycle for it to dismiss any notifications that it intends to display
3939 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003940 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003941 * <p>If an activity is ever started via any non-user-driven events such as
3942 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3943 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003944 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003945 */
3946 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003947 /**
3948 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3949 * this flag will cause the launched activity to be brought to the front of its
3950 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003951 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003952 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3953 * If D calls startActivity() with an Intent that resolves to the component
3954 * of activity B, then B will be brought to the front of the history stack,
3955 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003956 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003957 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003958 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003959 */
3960 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003961 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003962 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3963 * this flag will prevent the system from applying an activity transition
3964 * animation to go to the next activity state. This doesn't mean an
3965 * animation will never run -- if another activity change happens that doesn't
3966 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003967 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003968 * when you are going to do a series of activity operations but the
3969 * animation seen by the user shouldn't be driven by the first activity
3970 * change but rather a later one.
3971 */
3972 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3973 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003974 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3975 * this flag will cause any existing task that would be associated with the
3976 * activity to be cleared before the activity is started. That is, the activity
3977 * becomes the new root of an otherwise empty task, and any old activities
3978 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3979 */
3980 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3981 /**
3982 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3983 * this flag will cause a newly launching task to be placed on top of the current
3984 * home activity task (if there is one). That is, pressing back from the task
3985 * will always return the user to home even if that was not the last activity they
3986 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3987 */
3988 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3989 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003990 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3991 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003992 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003993 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003994 * this flag. When set and the task's activity is finished, the recents
3995 * entry will remain in the interface for the user to re-launch it, like a
3996 * recents entry for a top-level application.
3997 * <p>
3998 * The receiving activity can override this request with
3999 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4000 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004001 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004002 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004003 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004004
4005 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004006 * If set, when sending a broadcast only registered receivers will be
4007 * called -- no BroadcastReceiver components will be launched.
4008 */
4009 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004010 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004011 * If set, when sending a broadcast the new broadcast will replace
4012 * any existing pending broadcast that matches it. Matching is defined
4013 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4014 * true for the intents of the two broadcasts. When a match is found,
4015 * the new broadcast (and receivers associated with it) will replace the
4016 * existing one in the pending broadcast list, remaining at the same
4017 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004018 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004019 * <p>This flag is most typically used with sticky broadcasts, which
4020 * only care about delivering the most recent values of the broadcast
4021 * to their receivers.
4022 */
4023 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4024 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004025 * If set, when sending a broadcast the recipient is allowed to run at
4026 * foreground priority, with a shorter timeout interval. During normal
4027 * broadcasts the receivers are not automatically hoisted out of the
4028 * background priority class.
4029 */
4030 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4031 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004032 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4033 * They can still propagate results through to later receivers, but they can not prevent
4034 * later receivers from seeing the broadcast.
4035 */
4036 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4037 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004038 * If set, when sending a broadcast <i>before boot has completed</i> only
4039 * registered receivers will be called -- no BroadcastReceiver components
4040 * will be launched. Sticky intent state will be recorded properly even
4041 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4042 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004043 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004044 * <p>This flag is only for use by system sevices as a convenience to
4045 * avoid having to implement a more complex mechanism around detection
4046 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004047 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004048 * @hide
4049 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004050 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004051 /**
4052 * Set when this broadcast is for a boot upgrade, a special mode that
4053 * allows the broadcast to be sent before the system is ready and launches
4054 * the app process with no providers running in it.
4055 * @hide
4056 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004057 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004058
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004059 /**
4060 * @hide Flags that can't be changed with PendingIntent.
4061 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004062 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4063 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4064 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004065
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004066 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004067 // ---------------------------------------------------------------------
4068 // toUri() and parseUri() options.
4069
4070 /**
4071 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4072 * always has the "intent:" scheme. This syntax can be used when you want
4073 * to later disambiguate between URIs that are intended to describe an
4074 * Intent vs. all others that should be treated as raw URIs. When used
4075 * with {@link #parseUri}, any other scheme will result in a generic
4076 * VIEW action for that raw URI.
4077 */
4078 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004079
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004080 /**
4081 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4082 * always has the "android-app:" scheme. This is a variation of
4083 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4084 * http/https URI being delivered to a specific package name. The format
4085 * is:
4086 *
4087 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004088 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004089 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004090 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4091 * you must also include a scheme; including a path also requires both a host and a scheme.
4092 * The final #Intent; fragment can be used without a scheme, host, or path.
4093 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004094 * used with intents that have a {@link #setSelector}, since the base intent
4095 * will always have an explicit package name.</p>
4096 *
4097 * <p>Some examples of how this scheme maps to Intent objects:</p>
4098 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4099 * <colgroup align="left" />
4100 * <colgroup align="left" />
4101 * <thead>
4102 * <tr><th>URI</th> <th>Intent</th></tr>
4103 * </thead>
4104 *
4105 * <tbody>
4106 * <tr><td><code>android-app://com.example.app</code></td>
4107 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4108 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4109 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4110 * </table></td>
4111 * </tr>
4112 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4113 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4114 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4115 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4116 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4117 * </table></td>
4118 * </tr>
4119 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4120 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4121 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4122 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4123 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4124 * </table></td>
4125 * </tr>
4126 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4127 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4128 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4129 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4130 * </table></td>
4131 * </tr>
4132 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4133 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4134 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4135 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4136 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4137 * </table></td>
4138 * </tr>
4139 * <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>
4140 * <td><table border="" style="margin:0" >
4141 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4142 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4143 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4144 * </table></td>
4145 * </tr>
4146 * </tbody>
4147 * </table>
4148 */
4149 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4150
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004151 /**
4152 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4153 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4154 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4155 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4156 * generated Intent can not cause unexpected data access to happen.
4157 *
4158 * <p>If you do not trust the source of the URI being parsed, you should still do further
4159 * processing to protect yourself from it. In particular, when using it to start an
4160 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4161 * that can handle it.</p>
4162 */
4163 public static final int URI_ALLOW_UNSAFE = 1<<2;
4164
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004165 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004166
4167 private String mAction;
4168 private Uri mData;
4169 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004170 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004171 private ComponentName mComponent;
4172 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004173 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004174 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004175 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004176 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004177 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004178 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004179
4180 // ---------------------------------------------------------------------
4181
4182 /**
4183 * Create an empty intent.
4184 */
4185 public Intent() {
4186 }
4187
4188 /**
4189 * Copy constructor.
4190 */
4191 public Intent(Intent o) {
4192 this.mAction = o.mAction;
4193 this.mData = o.mData;
4194 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004195 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004196 this.mComponent = o.mComponent;
4197 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004198 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004199 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004200 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004201 }
4202 if (o.mExtras != null) {
4203 this.mExtras = new Bundle(o.mExtras);
4204 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004205 if (o.mSourceBounds != null) {
4206 this.mSourceBounds = new Rect(o.mSourceBounds);
4207 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004208 if (o.mSelector != null) {
4209 this.mSelector = new Intent(o.mSelector);
4210 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004211 if (o.mClipData != null) {
4212 this.mClipData = new ClipData(o.mClipData);
4213 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004214 }
4215
4216 @Override
4217 public Object clone() {
4218 return new Intent(this);
4219 }
4220
4221 private Intent(Intent o, boolean all) {
4222 this.mAction = o.mAction;
4223 this.mData = o.mData;
4224 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004225 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004226 this.mComponent = o.mComponent;
4227 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004228 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004229 }
4230 }
4231
4232 /**
4233 * Make a clone of only the parts of the Intent that are relevant for
4234 * filter matching: the action, data, type, component, and categories.
4235 */
4236 public Intent cloneFilter() {
4237 return new Intent(this, false);
4238 }
4239
4240 /**
4241 * Create an intent with a given action. All other fields (data, type,
4242 * class) are null. Note that the action <em>must</em> be in a
4243 * namespace because Intents are used globally in the system -- for
4244 * example the system VIEW action is android.intent.action.VIEW; an
4245 * application's custom action would be something like
4246 * com.google.app.myapp.CUSTOM_ACTION.
4247 *
4248 * @param action The Intent action, such as ACTION_VIEW.
4249 */
4250 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004251 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004252 }
4253
4254 /**
4255 * Create an intent with a given action and for a given data url. Note
4256 * that the action <em>must</em> be in a namespace because Intents are
4257 * used globally in the system -- for example the system VIEW action is
4258 * android.intent.action.VIEW; an application's custom action would be
4259 * something like com.google.app.myapp.CUSTOM_ACTION.
4260 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004261 * <p><em>Note: scheme and host name matching in the Android framework is
4262 * case-sensitive, unlike the formal RFC. As a result,
4263 * you should always ensure that you write your Uri with these elements
4264 * using lower case letters, and normalize any Uris you receive from
4265 * outside of Android to ensure the scheme and host is lower case.</em></p>
4266 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004267 * @param action The Intent action, such as ACTION_VIEW.
4268 * @param uri The Intent data URI.
4269 */
4270 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004271 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004272 mData = uri;
4273 }
4274
4275 /**
4276 * Create an intent for a specific component. All other fields (action, data,
4277 * type, class) are null, though they can be modified later with explicit
4278 * calls. This provides a convenient way to create an intent that is
4279 * intended to execute a hard-coded class name, rather than relying on the
4280 * system to find an appropriate class for you; see {@link #setComponent}
4281 * for more information on the repercussions of this.
4282 *
4283 * @param packageContext A Context of the application package implementing
4284 * this class.
4285 * @param cls The component class that is to be used for the intent.
4286 *
4287 * @see #setClass
4288 * @see #setComponent
4289 * @see #Intent(String, android.net.Uri , Context, Class)
4290 */
4291 public Intent(Context packageContext, Class<?> cls) {
4292 mComponent = new ComponentName(packageContext, cls);
4293 }
4294
4295 /**
4296 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004297 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004298 * construct the Intent and then calling {@link #setClass} to set its
4299 * class.
4300 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004301 * <p><em>Note: scheme and host name matching in the Android framework is
4302 * case-sensitive, unlike the formal RFC. As a result,
4303 * you should always ensure that you write your Uri with these elements
4304 * using lower case letters, and normalize any Uris you receive from
4305 * outside of Android to ensure the scheme and host is lower case.</em></p>
4306 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004307 * @param action The Intent action, such as ACTION_VIEW.
4308 * @param uri The Intent data URI.
4309 * @param packageContext A Context of the application package implementing
4310 * this class.
4311 * @param cls The component class that is to be used for the intent.
4312 *
4313 * @see #Intent(String, android.net.Uri)
4314 * @see #Intent(Context, Class)
4315 * @see #setClass
4316 * @see #setComponent
4317 */
4318 public Intent(String action, Uri uri,
4319 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004320 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004321 mData = uri;
4322 mComponent = new ComponentName(packageContext, cls);
4323 }
4324
4325 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004326 * Create an intent to launch the main (root) activity of a task. This
4327 * is the Intent that is started when the application's is launched from
4328 * Home. For anything else that wants to launch an application in the
4329 * same way, it is important that they use an Intent structured the same
4330 * way, and can use this function to ensure this is the case.
4331 *
4332 * <p>The returned Intent has the given Activity component as its explicit
4333 * component, {@link #ACTION_MAIN} as its action, and includes the
4334 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4335 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4336 * to do that through {@link #addFlags(int)} on the returned Intent.
4337 *
4338 * @param mainActivity The main activity component that this Intent will
4339 * launch.
4340 * @return Returns a newly created Intent that can be used to launch the
4341 * activity as a main application entry.
4342 *
4343 * @see #setClass
4344 * @see #setComponent
4345 */
4346 public static Intent makeMainActivity(ComponentName mainActivity) {
4347 Intent intent = new Intent(ACTION_MAIN);
4348 intent.setComponent(mainActivity);
4349 intent.addCategory(CATEGORY_LAUNCHER);
4350 return intent;
4351 }
4352
4353 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004354 * Make an Intent for the main activity of an application, without
4355 * specifying a specific activity to run but giving a selector to find
4356 * the activity. This results in a final Intent that is structured
4357 * the same as when the application is launched from
4358 * Home. For anything else that wants to launch an application in the
4359 * same way, it is important that they use an Intent structured the same
4360 * way, and can use this function to ensure this is the case.
4361 *
4362 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4363 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4364 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4365 * to do that through {@link #addFlags(int)} on the returned Intent.
4366 *
4367 * @param selectorAction The action name of the Intent's selector.
4368 * @param selectorCategory The name of a category to add to the Intent's
4369 * selector.
4370 * @return Returns a newly created Intent that can be used to launch the
4371 * activity as a main application entry.
4372 *
4373 * @see #setSelector(Intent)
4374 */
4375 public static Intent makeMainSelectorActivity(String selectorAction,
4376 String selectorCategory) {
4377 Intent intent = new Intent(ACTION_MAIN);
4378 intent.addCategory(CATEGORY_LAUNCHER);
4379 Intent selector = new Intent();
4380 selector.setAction(selectorAction);
4381 selector.addCategory(selectorCategory);
4382 intent.setSelector(selector);
4383 return intent;
4384 }
4385
4386 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004387 * Make an Intent that can be used to re-launch an application's task
4388 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4389 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4390 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4391 *
4392 * @param mainActivity The activity component that is the root of the
4393 * task; this is the activity that has been published in the application's
4394 * manifest as the main launcher icon.
4395 *
4396 * @return Returns a newly created Intent that can be used to relaunch the
4397 * activity's task in its root state.
4398 */
4399 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4400 Intent intent = makeMainActivity(mainActivity);
4401 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4402 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4403 return intent;
4404 }
4405
4406 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004407 * Call {@link #parseUri} with 0 flags.
4408 * @deprecated Use {@link #parseUri} instead.
4409 */
4410 @Deprecated
4411 public static Intent getIntent(String uri) throws URISyntaxException {
4412 return parseUri(uri, 0);
4413 }
Tom Taylord4a47292009-12-21 13:59:18 -08004414
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004415 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004416 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004417 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004418 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004419 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004420 *
4421 * <p>The URI given here must not be relative -- that is, it must include
4422 * the scheme and full path.
4423 *
4424 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004425 * @param flags Additional processing flags. Either 0,
4426 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004427 *
4428 * @return Intent The newly created Intent object.
4429 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004430 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4431 * it bad (as parsed by the Uri class) or the Intent data within the
4432 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004433 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004434 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004435 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004436 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004437 int i = 0;
4438 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004439 final boolean androidApp = uri.startsWith("android-app:");
4440
4441 // Validate intent scheme if requested.
4442 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4443 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004444 Intent intent = new Intent(ACTION_VIEW);
4445 try {
4446 intent.setData(Uri.parse(uri));
4447 } catch (IllegalArgumentException e) {
4448 throw new URISyntaxException(uri, e.getMessage());
4449 }
4450 return intent;
4451 }
4452 }
Tom Taylord4a47292009-12-21 13:59:18 -08004453
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004454 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004455 // simple case
4456 if (i == -1) {
4457 if (!androidApp) {
4458 return new Intent(ACTION_VIEW, Uri.parse(uri));
4459 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004460
4461 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004462 } else if (!uri.startsWith("#Intent;", i)) {
4463 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004464 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004465 } else {
4466 i = -1;
4467 }
4468 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004469
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004470 // new format
4471 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004472 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004473 boolean explicitAction = false;
4474 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004475
4476 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004477 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004478 String data;
4479 if (i >= 0) {
4480 data = uri.substring(0, i);
4481 i += 8; // length of "#Intent;"
4482 } else {
4483 data = uri;
4484 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004485
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004486 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004487 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004488 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004489 if (eq < 0) eq = i-1;
4490 int semi = uri.indexOf(';', i);
4491 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004492
4493 // action
4494 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004495 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004496 if (!inSelector) {
4497 explicitAction = true;
4498 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004499 }
4500
4501 // categories
4502 else if (uri.startsWith("category=", i)) {
4503 intent.addCategory(value);
4504 }
4505
4506 // type
4507 else if (uri.startsWith("type=", i)) {
4508 intent.mType = value;
4509 }
4510
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004511 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004512 else if (uri.startsWith("launchFlags=", i)) {
4513 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004514 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4515 intent.mFlags &= ~IMMUTABLE_FLAGS;
4516 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004517 }
4518
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004519 // package
4520 else if (uri.startsWith("package=", i)) {
4521 intent.mPackage = value;
4522 }
4523
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004524 // component
4525 else if (uri.startsWith("component=", i)) {
4526 intent.mComponent = ComponentName.unflattenFromString(value);
4527 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004528
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004529 // scheme
4530 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004531 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004532 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004533 } else {
4534 scheme = value;
4535 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004536 }
4537
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004538 // source bounds
4539 else if (uri.startsWith("sourceBounds=", i)) {
4540 intent.mSourceBounds = Rect.unflattenFromString(value);
4541 }
4542
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004543 // selector
4544 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4545 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004546 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004547 }
4548
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004549 // extra
4550 else {
4551 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004552 // create Bundle if it doesn't already exist
4553 if (intent.mExtras == null) intent.mExtras = new Bundle();
4554 Bundle b = intent.mExtras;
4555 // add EXTRA
4556 if (uri.startsWith("S.", i)) b.putString(key, value);
4557 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4558 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4559 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4560 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4561 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4562 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4563 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4564 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4565 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4566 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004567
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004568 // move to the next item
4569 i = semi + 1;
4570 }
4571
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004572 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004573 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004574 if (baseIntent.mPackage == null) {
4575 baseIntent.setSelector(intent);
4576 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004577 intent = baseIntent;
4578 }
4579
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004580 if (data != null) {
4581 if (data.startsWith("intent:")) {
4582 data = data.substring(7);
4583 if (scheme != null) {
4584 data = scheme + ':' + data;
4585 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004586 } else if (data.startsWith("android-app:")) {
4587 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
4588 // Correctly formed android-app, first part is package name.
4589 int end = data.indexOf('/', 14);
4590 if (end < 0) {
4591 // All we have is a package name.
4592 intent.mPackage = data.substring(14);
4593 if (!explicitAction) {
4594 intent.setAction(ACTION_MAIN);
4595 }
4596 data = "";
4597 } else {
4598 // Target the Intent at the given package name always.
4599 String authority = null;
4600 intent.mPackage = data.substring(14, end);
4601 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004602 if ((end+1) < data.length()) {
4603 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
4604 // Found a scheme, remember it.
4605 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004606 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004607 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
4608 // Found a authority, remember it.
4609 authority = data.substring(end+1, newEnd);
4610 end = newEnd;
4611 }
4612 } else {
4613 // All we have is a scheme.
4614 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004615 }
4616 }
4617 if (scheme == null) {
4618 // If there was no scheme, then this just targets the package.
4619 if (!explicitAction) {
4620 intent.setAction(ACTION_MAIN);
4621 }
4622 data = "";
4623 } else if (authority == null) {
4624 data = scheme + ":";
4625 } else {
4626 data = scheme + "://" + authority + data.substring(end);
4627 }
4628 }
4629 } else {
4630 data = "";
4631 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004632 }
Tom Taylord4a47292009-12-21 13:59:18 -08004633
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004634 if (data.length() > 0) {
4635 try {
4636 intent.mData = Uri.parse(data);
4637 } catch (IllegalArgumentException e) {
4638 throw new URISyntaxException(uri, e.getMessage());
4639 }
4640 }
4641 }
Tom Taylord4a47292009-12-21 13:59:18 -08004642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004643 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004644
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004645 } catch (IndexOutOfBoundsException e) {
4646 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4647 }
4648 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004650 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004651 return getIntentOld(uri, 0);
4652 }
4653
4654 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004655 Intent intent;
4656
4657 int i = uri.lastIndexOf('#');
4658 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004659 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004660 final int intentFragmentStart = i;
4661 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004662
4663 i++;
4664
4665 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004666 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004667 i += 7;
4668 int j = uri.indexOf(')', i);
4669 action = uri.substring(i, j);
4670 i = j + 1;
4671 }
4672
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004673 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004674
4675 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004676 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004677 i += 11;
4678 int j = uri.indexOf(')', i);
4679 while (i < j) {
4680 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004681 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004682 if (i < sep) {
4683 intent.addCategory(uri.substring(i, sep));
4684 }
4685 i = sep + 1;
4686 }
4687 i = j + 1;
4688 }
4689
4690 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004691 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004692 i += 5;
4693 int j = uri.indexOf(')', i);
4694 intent.mType = uri.substring(i, j);
4695 i = j + 1;
4696 }
4697
4698 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004699 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004700 i += 12;
4701 int j = uri.indexOf(')', i);
4702 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004703 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4704 intent.mFlags &= ~IMMUTABLE_FLAGS;
4705 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004706 i = j + 1;
4707 }
4708
4709 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004710 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004711 i += 10;
4712 int j = uri.indexOf(')', i);
4713 int sep = uri.indexOf('!', i);
4714 if (sep >= 0 && sep < j) {
4715 String pkg = uri.substring(i, sep);
4716 String cls = uri.substring(sep + 1, j);
4717 intent.mComponent = new ComponentName(pkg, cls);
4718 }
4719 i = j + 1;
4720 }
4721
4722 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004723 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004724 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004725
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004726 final int closeParen = uri.indexOf(')', i);
4727 if (closeParen == -1) throw new URISyntaxException(uri,
4728 "EXTRA missing trailing ')'", i);
4729
4730 while (i < closeParen) {
4731 // fetch the key value
4732 int j = uri.indexOf('=', i);
4733 if (j <= i + 1 || i >= closeParen) {
4734 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4735 }
4736 char type = uri.charAt(i);
4737 i++;
4738 String key = uri.substring(i, j);
4739 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004740
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004741 // get type-value
4742 j = uri.indexOf('!', i);
4743 if (j == -1 || j >= closeParen) j = closeParen;
4744 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4745 String value = uri.substring(i, j);
4746 i = j;
4747
4748 // create Bundle if it doesn't already exist
4749 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004750
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004751 // add item to bundle
4752 try {
4753 switch (type) {
4754 case 'S':
4755 intent.mExtras.putString(key, Uri.decode(value));
4756 break;
4757 case 'B':
4758 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4759 break;
4760 case 'b':
4761 intent.mExtras.putByte(key, Byte.parseByte(value));
4762 break;
4763 case 'c':
4764 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4765 break;
4766 case 'd':
4767 intent.mExtras.putDouble(key, Double.parseDouble(value));
4768 break;
4769 case 'f':
4770 intent.mExtras.putFloat(key, Float.parseFloat(value));
4771 break;
4772 case 'i':
4773 intent.mExtras.putInt(key, Integer.parseInt(value));
4774 break;
4775 case 'l':
4776 intent.mExtras.putLong(key, Long.parseLong(value));
4777 break;
4778 case 's':
4779 intent.mExtras.putShort(key, Short.parseShort(value));
4780 break;
4781 default:
4782 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4783 }
4784 } catch (NumberFormatException e) {
4785 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4786 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004787
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004788 char ch = uri.charAt(i);
4789 if (ch == ')') break;
4790 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4791 i++;
4792 }
4793 }
4794
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004795 if (isIntentFragment) {
4796 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4797 } else {
4798 intent.mData = Uri.parse(uri);
4799 }
Tom Taylord4a47292009-12-21 13:59:18 -08004800
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004801 if (intent.mAction == null) {
4802 // By default, if no action is specified, then use VIEW.
4803 intent.mAction = ACTION_VIEW;
4804 }
4805
4806 } else {
4807 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4808 }
4809
4810 return intent;
4811 }
4812
4813 /**
4814 * Retrieve the general action to be performed, such as
4815 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4816 * the information in the intent should be interpreted -- most importantly,
4817 * what to do with the data returned by {@link #getData}.
4818 *
4819 * @return The action of this intent or null if none is specified.
4820 *
4821 * @see #setAction
4822 */
4823 public String getAction() {
4824 return mAction;
4825 }
4826
4827 /**
4828 * Retrieve data this intent is operating on. This URI specifies the name
4829 * of the data; often it uses the content: scheme, specifying data in a
4830 * content provider. Other schemes may be handled by specific activities,
4831 * such as http: by the web browser.
4832 *
4833 * @return The URI of the data this intent is targeting or null.
4834 *
4835 * @see #getScheme
4836 * @see #setData
4837 */
4838 public Uri getData() {
4839 return mData;
4840 }
4841
4842 /**
4843 * The same as {@link #getData()}, but returns the URI as an encoded
4844 * String.
4845 */
4846 public String getDataString() {
4847 return mData != null ? mData.toString() : null;
4848 }
4849
4850 /**
4851 * Return the scheme portion of the intent's data. If the data is null or
4852 * does not include a scheme, null is returned. Otherwise, the scheme
4853 * prefix without the final ':' is returned, i.e. "http".
4854 *
4855 * <p>This is the same as calling getData().getScheme() (and checking for
4856 * null data).
4857 *
4858 * @return The scheme of this intent.
4859 *
4860 * @see #getData
4861 */
4862 public String getScheme() {
4863 return mData != null ? mData.getScheme() : null;
4864 }
4865
4866 /**
4867 * Retrieve any explicit MIME type included in the intent. This is usually
4868 * null, as the type is determined by the intent data.
4869 *
4870 * @return If a type was manually set, it is returned; else null is
4871 * returned.
4872 *
4873 * @see #resolveType(ContentResolver)
4874 * @see #setType
4875 */
4876 public String getType() {
4877 return mType;
4878 }
4879
4880 /**
4881 * Return the MIME data type of this intent. If the type field is
4882 * explicitly set, that is simply returned. Otherwise, if the data is set,
4883 * the type of that data is returned. If neither fields are set, a null is
4884 * returned.
4885 *
4886 * @return The MIME type of this intent.
4887 *
4888 * @see #getType
4889 * @see #resolveType(ContentResolver)
4890 */
4891 public String resolveType(Context context) {
4892 return resolveType(context.getContentResolver());
4893 }
4894
4895 /**
4896 * Return the MIME data type of this intent. If the type field is
4897 * explicitly set, that is simply returned. Otherwise, if the data is set,
4898 * the type of that data is returned. If neither fields are set, a null is
4899 * returned.
4900 *
4901 * @param resolver A ContentResolver that can be used to determine the MIME
4902 * type of the intent's data.
4903 *
4904 * @return The MIME type of this intent.
4905 *
4906 * @see #getType
4907 * @see #resolveType(Context)
4908 */
4909 public String resolveType(ContentResolver resolver) {
4910 if (mType != null) {
4911 return mType;
4912 }
4913 if (mData != null) {
4914 if ("content".equals(mData.getScheme())) {
4915 return resolver.getType(mData);
4916 }
4917 }
4918 return null;
4919 }
4920
4921 /**
4922 * Return the MIME data type of this intent, only if it will be needed for
4923 * intent resolution. This is not generally useful for application code;
4924 * it is used by the frameworks for communicating with back-end system
4925 * services.
4926 *
4927 * @param resolver A ContentResolver that can be used to determine the MIME
4928 * type of the intent's data.
4929 *
4930 * @return The MIME type of this intent, or null if it is unknown or not
4931 * needed.
4932 */
4933 public String resolveTypeIfNeeded(ContentResolver resolver) {
4934 if (mComponent != null) {
4935 return mType;
4936 }
4937 return resolveType(resolver);
4938 }
4939
4940 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004941 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004942 *
4943 * @param category The category to check.
4944 *
4945 * @return boolean True if the intent contains the category, else false.
4946 *
4947 * @see #getCategories
4948 * @see #addCategory
4949 */
4950 public boolean hasCategory(String category) {
4951 return mCategories != null && mCategories.contains(category);
4952 }
4953
4954 /**
4955 * Return the set of all categories in the intent. If there are no categories,
4956 * returns NULL.
4957 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004958 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004959 *
4960 * @see #hasCategory
4961 * @see #addCategory
4962 */
4963 public Set<String> getCategories() {
4964 return mCategories;
4965 }
4966
4967 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004968 * Return the specific selector associated with this Intent. If there is
4969 * none, returns null. See {@link #setSelector} for more information.
4970 *
4971 * @see #setSelector
4972 */
4973 public Intent getSelector() {
4974 return mSelector;
4975 }
4976
4977 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004978 * Return the {@link ClipData} associated with this Intent. If there is
4979 * none, returns null. See {@link #setClipData} for more information.
4980 *
John Spurlock125d1332013-11-25 11:58:37 -05004981 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004982 */
4983 public ClipData getClipData() {
4984 return mClipData;
4985 }
4986
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004987 /** @hide */
4988 public int getContentUserHint() {
4989 return mContentUserHint;
4990 }
4991
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004993 * Sets the ClassLoader that will be used when unmarshalling
4994 * any Parcelable values from the extras of this Intent.
4995 *
4996 * @param loader a ClassLoader, or null to use the default loader
4997 * at the time of unmarshalling.
4998 */
4999 public void setExtrasClassLoader(ClassLoader loader) {
5000 if (mExtras != null) {
5001 mExtras.setClassLoader(loader);
5002 }
5003 }
5004
5005 /**
5006 * Returns true if an extra value is associated with the given name.
5007 * @param name the extra's name
5008 * @return true if the given extra is present.
5009 */
5010 public boolean hasExtra(String name) {
5011 return mExtras != null && mExtras.containsKey(name);
5012 }
5013
5014 /**
5015 * Returns true if the Intent's extras contain a parcelled file descriptor.
5016 * @return true if the Intent contains a parcelled file descriptor.
5017 */
5018 public boolean hasFileDescriptors() {
5019 return mExtras != null && mExtras.hasFileDescriptors();
5020 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005021
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04005022 /** @hide */
5023 public void setAllowFds(boolean allowFds) {
5024 if (mExtras != null) {
5025 mExtras.setAllowFds(allowFds);
5026 }
5027 }
5028
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005029 /**
5030 * Retrieve extended data from the intent.
5031 *
5032 * @param name The name of the desired item.
5033 *
5034 * @return the value of an item that previously added with putExtra()
5035 * or null if none was found.
5036 *
5037 * @deprecated
5038 * @hide
5039 */
5040 @Deprecated
5041 public Object getExtra(String name) {
5042 return getExtra(name, null);
5043 }
5044
5045 /**
5046 * Retrieve extended data from the intent.
5047 *
5048 * @param name The name of the desired item.
5049 * @param defaultValue the value to be returned if no value of the desired
5050 * type is stored with the given name.
5051 *
5052 * @return the value of an item that previously added with putExtra()
5053 * or the default value if none was found.
5054 *
5055 * @see #putExtra(String, boolean)
5056 */
5057 public boolean getBooleanExtra(String name, boolean defaultValue) {
5058 return mExtras == null ? defaultValue :
5059 mExtras.getBoolean(name, defaultValue);
5060 }
5061
5062 /**
5063 * Retrieve extended data from the intent.
5064 *
5065 * @param name The name of the desired item.
5066 * @param defaultValue the value to be returned if no value of the desired
5067 * type is stored with the given name.
5068 *
5069 * @return the value of an item that previously added with putExtra()
5070 * or the default value if none was found.
5071 *
5072 * @see #putExtra(String, byte)
5073 */
5074 public byte getByteExtra(String name, byte defaultValue) {
5075 return mExtras == null ? defaultValue :
5076 mExtras.getByte(name, defaultValue);
5077 }
5078
5079 /**
5080 * Retrieve extended data from the intent.
5081 *
5082 * @param name The name of the desired item.
5083 * @param defaultValue the value to be returned if no value of the desired
5084 * type is stored with the given name.
5085 *
5086 * @return the value of an item that previously added with putExtra()
5087 * or the default value if none was found.
5088 *
5089 * @see #putExtra(String, short)
5090 */
5091 public short getShortExtra(String name, short defaultValue) {
5092 return mExtras == null ? defaultValue :
5093 mExtras.getShort(name, defaultValue);
5094 }
5095
5096 /**
5097 * Retrieve extended data from the intent.
5098 *
5099 * @param name The name of the desired item.
5100 * @param defaultValue the value to be returned if no value of the desired
5101 * type is stored with the given name.
5102 *
5103 * @return the value of an item that previously added with putExtra()
5104 * or the default value if none was found.
5105 *
5106 * @see #putExtra(String, char)
5107 */
5108 public char getCharExtra(String name, char defaultValue) {
5109 return mExtras == null ? defaultValue :
5110 mExtras.getChar(name, defaultValue);
5111 }
5112
5113 /**
5114 * Retrieve extended data from the intent.
5115 *
5116 * @param name The name of the desired item.
5117 * @param defaultValue the value to be returned if no value of the desired
5118 * type is stored with the given name.
5119 *
5120 * @return the value of an item that previously added with putExtra()
5121 * or the default value if none was found.
5122 *
5123 * @see #putExtra(String, int)
5124 */
5125 public int getIntExtra(String name, int defaultValue) {
5126 return mExtras == null ? defaultValue :
5127 mExtras.getInt(name, defaultValue);
5128 }
5129
5130 /**
5131 * Retrieve extended data from the intent.
5132 *
5133 * @param name The name of the desired item.
5134 * @param defaultValue the value to be returned if no value of the desired
5135 * type is stored with the given name.
5136 *
5137 * @return the value of an item that previously added with putExtra()
5138 * or the default value if none was found.
5139 *
5140 * @see #putExtra(String, long)
5141 */
5142 public long getLongExtra(String name, long defaultValue) {
5143 return mExtras == null ? defaultValue :
5144 mExtras.getLong(name, defaultValue);
5145 }
5146
5147 /**
5148 * Retrieve extended data from the intent.
5149 *
5150 * @param name The name of the desired item.
5151 * @param defaultValue the value to be returned if no value of the desired
5152 * type is stored with the given name.
5153 *
5154 * @return the value of an item that previously added with putExtra(),
5155 * or the default value if no such item is present
5156 *
5157 * @see #putExtra(String, float)
5158 */
5159 public float getFloatExtra(String name, float defaultValue) {
5160 return mExtras == null ? defaultValue :
5161 mExtras.getFloat(name, defaultValue);
5162 }
5163
5164 /**
5165 * Retrieve extended data from the intent.
5166 *
5167 * @param name The name of the desired item.
5168 * @param defaultValue the value to be returned if no value of the desired
5169 * type is stored with the given name.
5170 *
5171 * @return the value of an item that previously added with putExtra()
5172 * or the default value if none was found.
5173 *
5174 * @see #putExtra(String, double)
5175 */
5176 public double getDoubleExtra(String name, double defaultValue) {
5177 return mExtras == null ? defaultValue :
5178 mExtras.getDouble(name, defaultValue);
5179 }
5180
5181 /**
5182 * Retrieve extended data from the intent.
5183 *
5184 * @param name The name of the desired item.
5185 *
5186 * @return the value of an item that previously added with putExtra()
5187 * or null if no String value was found.
5188 *
5189 * @see #putExtra(String, String)
5190 */
5191 public String getStringExtra(String name) {
5192 return mExtras == null ? null : mExtras.getString(name);
5193 }
5194
5195 /**
5196 * Retrieve extended data from the intent.
5197 *
5198 * @param name The name of the desired item.
5199 *
5200 * @return the value of an item that previously added with putExtra()
5201 * or null if no CharSequence value was found.
5202 *
5203 * @see #putExtra(String, CharSequence)
5204 */
5205 public CharSequence getCharSequenceExtra(String name) {
5206 return mExtras == null ? null : mExtras.getCharSequence(name);
5207 }
5208
5209 /**
5210 * Retrieve extended data from the intent.
5211 *
5212 * @param name The name of the desired item.
5213 *
5214 * @return the value of an item that previously added with putExtra()
5215 * or null if no Parcelable value was found.
5216 *
5217 * @see #putExtra(String, Parcelable)
5218 */
5219 public <T extends Parcelable> T getParcelableExtra(String name) {
5220 return mExtras == null ? null : mExtras.<T>getParcelable(name);
5221 }
5222
5223 /**
5224 * Retrieve extended data from the intent.
5225 *
5226 * @param name The name of the desired item.
5227 *
5228 * @return the value of an item that previously added with putExtra()
5229 * or null if no Parcelable[] value was found.
5230 *
5231 * @see #putExtra(String, Parcelable[])
5232 */
5233 public Parcelable[] getParcelableArrayExtra(String name) {
5234 return mExtras == null ? null : mExtras.getParcelableArray(name);
5235 }
5236
5237 /**
5238 * Retrieve extended data from the intent.
5239 *
5240 * @param name The name of the desired item.
5241 *
5242 * @return the value of an item that previously added with putExtra()
5243 * or null if no ArrayList<Parcelable> value was found.
5244 *
5245 * @see #putParcelableArrayListExtra(String, ArrayList)
5246 */
5247 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
5248 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
5249 }
5250
5251 /**
5252 * Retrieve extended data from the intent.
5253 *
5254 * @param name The name of the desired item.
5255 *
5256 * @return the value of an item that previously added with putExtra()
5257 * or null if no Serializable value was found.
5258 *
5259 * @see #putExtra(String, Serializable)
5260 */
5261 public Serializable getSerializableExtra(String name) {
5262 return mExtras == null ? null : mExtras.getSerializable(name);
5263 }
5264
5265 /**
5266 * Retrieve extended data from the intent.
5267 *
5268 * @param name The name of the desired item.
5269 *
5270 * @return the value of an item that previously added with putExtra()
5271 * or null if no ArrayList<Integer> value was found.
5272 *
5273 * @see #putIntegerArrayListExtra(String, ArrayList)
5274 */
5275 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
5276 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
5277 }
5278
5279 /**
5280 * Retrieve extended data from the intent.
5281 *
5282 * @param name The name of the desired item.
5283 *
5284 * @return the value of an item that previously added with putExtra()
5285 * or null if no ArrayList<String> value was found.
5286 *
5287 * @see #putStringArrayListExtra(String, ArrayList)
5288 */
5289 public ArrayList<String> getStringArrayListExtra(String name) {
5290 return mExtras == null ? null : mExtras.getStringArrayList(name);
5291 }
5292
5293 /**
5294 * Retrieve extended data from the intent.
5295 *
5296 * @param name The name of the desired item.
5297 *
5298 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005299 * or null if no ArrayList<CharSequence> value was found.
5300 *
5301 * @see #putCharSequenceArrayListExtra(String, ArrayList)
5302 */
5303 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
5304 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5305 }
5306
5307 /**
5308 * Retrieve extended data from the intent.
5309 *
5310 * @param name The name of the desired item.
5311 *
5312 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005313 * or null if no boolean array value was found.
5314 *
5315 * @see #putExtra(String, boolean[])
5316 */
5317 public boolean[] getBooleanArrayExtra(String name) {
5318 return mExtras == null ? null : mExtras.getBooleanArray(name);
5319 }
5320
5321 /**
5322 * Retrieve extended data from the intent.
5323 *
5324 * @param name The name of the desired item.
5325 *
5326 * @return the value of an item that previously added with putExtra()
5327 * or null if no byte array value was found.
5328 *
5329 * @see #putExtra(String, byte[])
5330 */
5331 public byte[] getByteArrayExtra(String name) {
5332 return mExtras == null ? null : mExtras.getByteArray(name);
5333 }
5334
5335 /**
5336 * Retrieve extended data from the intent.
5337 *
5338 * @param name The name of the desired item.
5339 *
5340 * @return the value of an item that previously added with putExtra()
5341 * or null if no short array value was found.
5342 *
5343 * @see #putExtra(String, short[])
5344 */
5345 public short[] getShortArrayExtra(String name) {
5346 return mExtras == null ? null : mExtras.getShortArray(name);
5347 }
5348
5349 /**
5350 * Retrieve extended data from the intent.
5351 *
5352 * @param name The name of the desired item.
5353 *
5354 * @return the value of an item that previously added with putExtra()
5355 * or null if no char array value was found.
5356 *
5357 * @see #putExtra(String, char[])
5358 */
5359 public char[] getCharArrayExtra(String name) {
5360 return mExtras == null ? null : mExtras.getCharArray(name);
5361 }
5362
5363 /**
5364 * Retrieve extended data from the intent.
5365 *
5366 * @param name The name of the desired item.
5367 *
5368 * @return the value of an item that previously added with putExtra()
5369 * or null if no int array value was found.
5370 *
5371 * @see #putExtra(String, int[])
5372 */
5373 public int[] getIntArrayExtra(String name) {
5374 return mExtras == null ? null : mExtras.getIntArray(name);
5375 }
5376
5377 /**
5378 * Retrieve extended data from the intent.
5379 *
5380 * @param name The name of the desired item.
5381 *
5382 * @return the value of an item that previously added with putExtra()
5383 * or null if no long array value was found.
5384 *
5385 * @see #putExtra(String, long[])
5386 */
5387 public long[] getLongArrayExtra(String name) {
5388 return mExtras == null ? null : mExtras.getLongArray(name);
5389 }
5390
5391 /**
5392 * Retrieve extended data from the intent.
5393 *
5394 * @param name The name of the desired item.
5395 *
5396 * @return the value of an item that previously added with putExtra()
5397 * or null if no float array value was found.
5398 *
5399 * @see #putExtra(String, float[])
5400 */
5401 public float[] getFloatArrayExtra(String name) {
5402 return mExtras == null ? null : mExtras.getFloatArray(name);
5403 }
5404
5405 /**
5406 * Retrieve extended data from the intent.
5407 *
5408 * @param name The name of the desired item.
5409 *
5410 * @return the value of an item that previously added with putExtra()
5411 * or null if no double array value was found.
5412 *
5413 * @see #putExtra(String, double[])
5414 */
5415 public double[] getDoubleArrayExtra(String name) {
5416 return mExtras == null ? null : mExtras.getDoubleArray(name);
5417 }
5418
5419 /**
5420 * Retrieve extended data from the intent.
5421 *
5422 * @param name The name of the desired item.
5423 *
5424 * @return the value of an item that previously added with putExtra()
5425 * or null if no String array value was found.
5426 *
5427 * @see #putExtra(String, String[])
5428 */
5429 public String[] getStringArrayExtra(String name) {
5430 return mExtras == null ? null : mExtras.getStringArray(name);
5431 }
5432
5433 /**
5434 * Retrieve extended data from the intent.
5435 *
5436 * @param name The name of the desired item.
5437 *
5438 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005439 * or null if no CharSequence array value was found.
5440 *
5441 * @see #putExtra(String, CharSequence[])
5442 */
5443 public CharSequence[] getCharSequenceArrayExtra(String name) {
5444 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5445 }
5446
5447 /**
5448 * Retrieve extended data from the intent.
5449 *
5450 * @param name The name of the desired item.
5451 *
5452 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005453 * or null if no Bundle value was found.
5454 *
5455 * @see #putExtra(String, Bundle)
5456 */
5457 public Bundle getBundleExtra(String name) {
5458 return mExtras == null ? null : mExtras.getBundle(name);
5459 }
5460
5461 /**
5462 * Retrieve extended data from the intent.
5463 *
5464 * @param name The name of the desired item.
5465 *
5466 * @return the value of an item that previously added with putExtra()
5467 * or null if no IBinder value was found.
5468 *
5469 * @see #putExtra(String, IBinder)
5470 *
5471 * @deprecated
5472 * @hide
5473 */
5474 @Deprecated
5475 public IBinder getIBinderExtra(String name) {
5476 return mExtras == null ? null : mExtras.getIBinder(name);
5477 }
5478
5479 /**
5480 * Retrieve extended data from the intent.
5481 *
5482 * @param name The name of the desired item.
5483 * @param defaultValue The default value to return in case no item is
5484 * associated with the key 'name'
5485 *
5486 * @return the value of an item that previously added with putExtra()
5487 * or defaultValue if none was found.
5488 *
5489 * @see #putExtra
5490 *
5491 * @deprecated
5492 * @hide
5493 */
5494 @Deprecated
5495 public Object getExtra(String name, Object defaultValue) {
5496 Object result = defaultValue;
5497 if (mExtras != null) {
5498 Object result2 = mExtras.get(name);
5499 if (result2 != null) {
5500 result = result2;
5501 }
5502 }
5503
5504 return result;
5505 }
5506
5507 /**
5508 * Retrieves a map of extended data from the intent.
5509 *
5510 * @return the map of all extras previously added with putExtra(),
5511 * or null if none have been added.
5512 */
5513 public Bundle getExtras() {
5514 return (mExtras != null)
5515 ? new Bundle(mExtras)
5516 : null;
5517 }
5518
5519 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07005520 * Filter extras to only basic types.
5521 * @hide
5522 */
5523 public void removeUnsafeExtras() {
5524 if (mExtras != null) {
5525 mExtras.filterValues();
5526 }
5527 }
5528
5529 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005530 * Retrieve any special flags associated with this intent. You will
5531 * normally just set them with {@link #setFlags} and let the system
5532 * take the appropriate action with them.
5533 *
5534 * @return int The currently set flags.
5535 *
5536 * @see #setFlags
5537 */
5538 public int getFlags() {
5539 return mFlags;
5540 }
5541
Dianne Hackborne7f97212011-02-24 14:40:20 -08005542 /** @hide */
5543 public boolean isExcludingStopped() {
5544 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5545 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5546 }
5547
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005548 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005549 * Retrieve the application package name this Intent is limited to. When
5550 * resolving an Intent, if non-null this limits the resolution to only
5551 * components in the given application package.
5552 *
5553 * @return The name of the application package for the Intent.
5554 *
5555 * @see #resolveActivity
5556 * @see #setPackage
5557 */
5558 public String getPackage() {
5559 return mPackage;
5560 }
5561
5562 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005563 * Retrieve the concrete component associated with the intent. When receiving
5564 * an intent, this is the component that was found to best handle it (that is,
5565 * yourself) and will always be non-null; in all other cases it will be
5566 * null unless explicitly set.
5567 *
5568 * @return The name of the application component to handle the intent.
5569 *
5570 * @see #resolveActivity
5571 * @see #setComponent
5572 */
5573 public ComponentName getComponent() {
5574 return mComponent;
5575 }
5576
5577 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005578 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5579 * used as a hint to the receiver for animations and the like. Null means that there
5580 * is no source bounds.
5581 */
5582 public Rect getSourceBounds() {
5583 return mSourceBounds;
5584 }
5585
5586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005587 * Return the Activity component that should be used to handle this intent.
5588 * The appropriate component is determined based on the information in the
5589 * intent, evaluated as follows:
5590 *
5591 * <p>If {@link #getComponent} returns an explicit class, that is returned
5592 * without any further consideration.
5593 *
5594 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5595 * category to be considered.
5596 *
5597 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5598 * action.
5599 *
5600 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5601 * this type.
5602 *
5603 * <p>If {@link #addCategory} has added any categories, the activity must
5604 * handle ALL of the categories specified.
5605 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005606 * <p>If {@link #getPackage} is non-NULL, only activity components in
5607 * that application package will be considered.
5608 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005609 * <p>If there are no activities that satisfy all of these conditions, a
5610 * null string is returned.
5611 *
5612 * <p>If multiple activities are found to satisfy the intent, the one with
5613 * the highest priority will be used. If there are multiple activities
5614 * with the same priority, the system will either pick the best activity
5615 * based on user preference, or resolve to a system class that will allow
5616 * the user to pick an activity and forward from there.
5617 *
5618 * <p>This method is implemented simply by calling
5619 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5620 * true.</p>
5621 * <p> This API is called for you as part of starting an activity from an
5622 * intent. You do not normally need to call it yourself.</p>
5623 *
5624 * @param pm The package manager with which to resolve the Intent.
5625 *
5626 * @return Name of the component implementing an activity that can
5627 * display the intent.
5628 *
5629 * @see #setComponent
5630 * @see #getComponent
5631 * @see #resolveActivityInfo
5632 */
5633 public ComponentName resolveActivity(PackageManager pm) {
5634 if (mComponent != null) {
5635 return mComponent;
5636 }
5637
5638 ResolveInfo info = pm.resolveActivity(
5639 this, PackageManager.MATCH_DEFAULT_ONLY);
5640 if (info != null) {
5641 return new ComponentName(
5642 info.activityInfo.applicationInfo.packageName,
5643 info.activityInfo.name);
5644 }
5645
5646 return null;
5647 }
5648
5649 /**
5650 * Resolve the Intent into an {@link ActivityInfo}
5651 * describing the activity that should execute the intent. Resolution
5652 * follows the same rules as described for {@link #resolveActivity}, but
5653 * you get back the completely information about the resolved activity
5654 * instead of just its class name.
5655 *
5656 * @param pm The package manager with which to resolve the Intent.
5657 * @param flags Addition information to retrieve as per
5658 * {@link PackageManager#getActivityInfo(ComponentName, int)
5659 * PackageManager.getActivityInfo()}.
5660 *
5661 * @return PackageManager.ActivityInfo
5662 *
5663 * @see #resolveActivity
5664 */
5665 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5666 ActivityInfo ai = null;
5667 if (mComponent != null) {
5668 try {
5669 ai = pm.getActivityInfo(mComponent, flags);
5670 } catch (PackageManager.NameNotFoundException e) {
5671 // ignore
5672 }
5673 } else {
5674 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005675 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005676 if (info != null) {
5677 ai = info.activityInfo;
5678 }
5679 }
5680
5681 return ai;
5682 }
5683
5684 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005685 * Special function for use by the system to resolve service
5686 * intents to system apps. Throws an exception if there are
5687 * multiple potential matches to the Intent. Returns null if
5688 * there are no matches.
5689 * @hide
5690 */
5691 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5692 if (mComponent != null) {
5693 return mComponent;
5694 }
5695
5696 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5697 if (results == null) {
5698 return null;
5699 }
5700 ComponentName comp = null;
5701 for (int i=0; i<results.size(); i++) {
5702 ResolveInfo ri = results.get(i);
5703 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5704 continue;
5705 }
5706 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5707 ri.serviceInfo.name);
5708 if (comp != null) {
5709 throw new IllegalStateException("Multiple system services handle " + this
5710 + ": " + comp + ", " + foundComp);
5711 }
5712 comp = foundComp;
5713 }
5714 return comp;
5715 }
5716
5717 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005718 * Set the general action to be performed.
5719 *
5720 * @param action An action name, such as ACTION_VIEW. Application-specific
5721 * actions should be prefixed with the vendor's package name.
5722 *
5723 * @return Returns the same Intent object, for chaining multiple calls
5724 * into a single statement.
5725 *
5726 * @see #getAction
5727 */
5728 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005729 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005730 return this;
5731 }
5732
5733 /**
5734 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005735 * clears any type that was previously set by {@link #setType} or
5736 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005737 *
Nick Pellyccae4122012-01-09 14:12:58 -08005738 * <p><em>Note: scheme matching in the Android framework is
5739 * case-sensitive, unlike the formal RFC. As a result,
5740 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005741 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005742 * {@link #setDataAndNormalize}
5743 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005744 *
Nick Pellyccae4122012-01-09 14:12:58 -08005745 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005746 *
5747 * @return Returns the same Intent object, for chaining multiple calls
5748 * into a single statement.
5749 *
5750 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005751 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005752 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005753 */
5754 public Intent setData(Uri data) {
5755 mData = data;
5756 mType = null;
5757 return this;
5758 }
5759
5760 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005761 * Normalize and set the data this intent is operating on.
5762 *
5763 * <p>This method automatically clears any type that was
5764 * previously set (for example, by {@link #setType}).
5765 *
5766 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005767 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005768 * so really this is just a convenience method for
5769 * <pre>
5770 * setData(data.normalize())
5771 * </pre>
5772 *
5773 * @param data The Uri of the data this intent is now targeting.
5774 *
5775 * @return Returns the same Intent object, for chaining multiple calls
5776 * into a single statement.
5777 *
5778 * @see #getData
5779 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005780 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005781 */
5782 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005783 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005784 }
5785
5786 /**
5787 * Set an explicit MIME data type.
5788 *
5789 * <p>This is used to create intents that only specify a type and not data,
5790 * for example to indicate the type of data to return.
5791 *
5792 * <p>This method automatically clears any data that was
5793 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005794 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005795 * <p><em>Note: MIME type matching in the Android framework is
5796 * case-sensitive, unlike formal RFC MIME types. As a result,
5797 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005798 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5799 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005800 *
5801 * @param type The MIME type of the data being handled by this intent.
5802 *
5803 * @return Returns the same Intent object, for chaining multiple calls
5804 * into a single statement.
5805 *
5806 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005807 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005808 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005809 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005810 */
5811 public Intent setType(String type) {
5812 mData = null;
5813 mType = type;
5814 return this;
5815 }
5816
5817 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005818 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005819 *
Nick Pellyccae4122012-01-09 14:12:58 -08005820 * <p>This is used to create intents that only specify a type and not data,
5821 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005822 *
Nick Pellyccae4122012-01-09 14:12:58 -08005823 * <p>This method automatically clears any data that was
5824 * previously set (for example by {@link #setData}).
5825 *
5826 * <p>The MIME type is normalized using
5827 * {@link #normalizeMimeType} before it is set,
5828 * so really this is just a convenience method for
5829 * <pre>
5830 * setType(Intent.normalizeMimeType(type))
5831 * </pre>
5832 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005833 * @param type The MIME type of the data being handled by this intent.
5834 *
5835 * @return Returns the same Intent object, for chaining multiple calls
5836 * into a single statement.
5837 *
Nick Pellyccae4122012-01-09 14:12:58 -08005838 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005839 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005840 * @see #normalizeMimeType
5841 */
5842 public Intent setTypeAndNormalize(String type) {
5843 return setType(normalizeMimeType(type));
5844 }
5845
5846 /**
5847 * (Usually optional) Set the data for the intent along with an explicit
5848 * MIME data type. This method should very rarely be used -- it allows you
5849 * to override the MIME type that would ordinarily be inferred from the
5850 * data with your own type given here.
5851 *
5852 * <p><em>Note: MIME type and Uri scheme matching in the
5853 * Android framework is case-sensitive, unlike the formal RFC definitions.
5854 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005855 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005856 * {@link #setDataAndTypeAndNormalize}
5857 * to ensure that they are converted to lower case.</em>
5858 *
5859 * @param data The Uri of the data this intent is now targeting.
5860 * @param type The MIME type of the data being handled by this intent.
5861 *
5862 * @return Returns the same Intent object, for chaining multiple calls
5863 * into a single statement.
5864 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005865 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005866 * @see #setData
5867 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005868 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005869 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005870 */
5871 public Intent setDataAndType(Uri data, String type) {
5872 mData = data;
5873 mType = type;
5874 return this;
5875 }
5876
5877 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005878 * (Usually optional) Normalize and set both the data Uri and an explicit
5879 * MIME data type. This method should very rarely be used -- it allows you
5880 * to override the MIME type that would ordinarily be inferred from the
5881 * data with your own type given here.
5882 *
5883 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005884 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005885 * before they are set, so really this is just a convenience method for
5886 * <pre>
5887 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5888 * </pre>
5889 *
5890 * @param data The Uri of the data this intent is now targeting.
5891 * @param type The MIME type of the data being handled by this intent.
5892 *
5893 * @return Returns the same Intent object, for chaining multiple calls
5894 * into a single statement.
5895 *
5896 * @see #setType
5897 * @see #setData
5898 * @see #setDataAndType
5899 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005900 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005901 */
5902 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005903 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005904 }
5905
5906 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005907 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005908 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005909 * activities that provide <em>all</em> of the requested categories will be
5910 * used.
5911 *
5912 * @param category The desired category. This can be either one of the
5913 * predefined Intent categories, or a custom category in your own
5914 * namespace.
5915 *
5916 * @return Returns the same Intent object, for chaining multiple calls
5917 * into a single statement.
5918 *
5919 * @see #hasCategory
5920 * @see #removeCategory
5921 */
5922 public Intent addCategory(String category) {
5923 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005924 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005925 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005926 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005927 return this;
5928 }
5929
5930 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005931 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005932 *
5933 * @param category The category to remove.
5934 *
5935 * @see #addCategory
5936 */
5937 public void removeCategory(String category) {
5938 if (mCategories != null) {
5939 mCategories.remove(category);
5940 if (mCategories.size() == 0) {
5941 mCategories = null;
5942 }
5943 }
5944 }
5945
5946 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005947 * Set a selector for this Intent. This is a modification to the kinds of
5948 * things the Intent will match. If the selector is set, it will be used
5949 * when trying to find entities that can handle the Intent, instead of the
5950 * main contents of the Intent. This allows you build an Intent containing
5951 * a generic protocol while targeting it more specifically.
5952 *
5953 * <p>An example of where this may be used is with things like
5954 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5955 * Intent that will launch the Browser application. However, the correct
5956 * main entry point of an application is actually {@link #ACTION_MAIN}
5957 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5958 * used to specify the actual Activity to launch. If you launch the browser
5959 * with something different, undesired behavior may happen if the user has
5960 * previously or later launches it the normal way, since they do not match.
5961 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5962 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5963 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5964 *
5965 * <p>Setting a selector does not impact the behavior of
5966 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5967 * desired behavior of a selector -- it does not impact the base meaning
5968 * of the Intent, just what kinds of things will be matched against it
5969 * when determining who can handle it.</p>
5970 *
5971 * <p>You can not use both a selector and {@link #setPackage(String)} on
5972 * the same base Intent.</p>
5973 *
5974 * @param selector The desired selector Intent; set to null to not use
5975 * a special selector.
5976 */
5977 public void setSelector(Intent selector) {
5978 if (selector == this) {
5979 throw new IllegalArgumentException(
5980 "Intent being set as a selector of itself");
5981 }
5982 if (selector != null && mPackage != null) {
5983 throw new IllegalArgumentException(
5984 "Can't set selector when package name is already set");
5985 }
5986 mSelector = selector;
5987 }
5988
5989 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005990 * Set a {@link ClipData} associated with this Intent. This replaces any
5991 * previously set ClipData.
5992 *
5993 * <p>The ClipData in an intent is not used for Intent matching or other
5994 * such operations. Semantically it is like extras, used to transmit
5995 * additional data with the Intent. The main feature of using this over
5996 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5997 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5998 * items included in the clip data. This is useful, in particular, if
5999 * you want to transmit an Intent containing multiple <code>content:</code>
6000 * URIs for which the recipient may not have global permission to access the
6001 * content provider.
6002 *
6003 * <p>If the ClipData contains items that are themselves Intents, any
6004 * grant flags in those Intents will be ignored. Only the top-level flags
6005 * of the main Intent are respected, and will be applied to all Uri or
6006 * Intent items in the clip (or sub-items of the clip).
6007 *
6008 * <p>The MIME type, label, and icon in the ClipData object are not
6009 * directly used by Intent. Applications should generally rely on the
6010 * MIME type of the Intent itself, not what it may find in the ClipData.
6011 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05006012 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006013 *
6014 * @param clip The new clip to set. May be null to clear the current clip.
6015 */
6016 public void setClipData(ClipData clip) {
6017 mClipData = clip;
6018 }
6019
6020 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006021 * This is NOT a secure mechanism to identify the user who sent the intent.
6022 * When the intent is sent to a different user, it is used to fix uris by adding the userId
6023 * who sent the intent.
6024 * @hide
6025 */
6026 public void setContentUserHint(int contentUserHint) {
6027 mContentUserHint = contentUserHint;
6028 }
6029
6030 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006031 * Add extended data to the intent. The name must include a package
6032 * prefix, for example the app com.android.contacts would use names
6033 * like "com.android.contacts.ShowAll".
6034 *
6035 * @param name The name of the extra data, with package prefix.
6036 * @param value The boolean data value.
6037 *
6038 * @return Returns the same Intent object, for chaining multiple calls
6039 * into a single statement.
6040 *
6041 * @see #putExtras
6042 * @see #removeExtra
6043 * @see #getBooleanExtra(String, boolean)
6044 */
6045 public Intent putExtra(String name, boolean value) {
6046 if (mExtras == null) {
6047 mExtras = new Bundle();
6048 }
6049 mExtras.putBoolean(name, value);
6050 return this;
6051 }
6052
6053 /**
6054 * Add extended data to the intent. The name must include a package
6055 * prefix, for example the app com.android.contacts would use names
6056 * like "com.android.contacts.ShowAll".
6057 *
6058 * @param name The name of the extra data, with package prefix.
6059 * @param value The byte data value.
6060 *
6061 * @return Returns the same Intent object, for chaining multiple calls
6062 * into a single statement.
6063 *
6064 * @see #putExtras
6065 * @see #removeExtra
6066 * @see #getByteExtra(String, byte)
6067 */
6068 public Intent putExtra(String name, byte value) {
6069 if (mExtras == null) {
6070 mExtras = new Bundle();
6071 }
6072 mExtras.putByte(name, value);
6073 return this;
6074 }
6075
6076 /**
6077 * Add extended data to the intent. The name must include a package
6078 * prefix, for example the app com.android.contacts would use names
6079 * like "com.android.contacts.ShowAll".
6080 *
6081 * @param name The name of the extra data, with package prefix.
6082 * @param value The char data value.
6083 *
6084 * @return Returns the same Intent object, for chaining multiple calls
6085 * into a single statement.
6086 *
6087 * @see #putExtras
6088 * @see #removeExtra
6089 * @see #getCharExtra(String, char)
6090 */
6091 public Intent putExtra(String name, char value) {
6092 if (mExtras == null) {
6093 mExtras = new Bundle();
6094 }
6095 mExtras.putChar(name, value);
6096 return this;
6097 }
6098
6099 /**
6100 * Add extended data to the intent. The name must include a package
6101 * prefix, for example the app com.android.contacts would use names
6102 * like "com.android.contacts.ShowAll".
6103 *
6104 * @param name The name of the extra data, with package prefix.
6105 * @param value The short data value.
6106 *
6107 * @return Returns the same Intent object, for chaining multiple calls
6108 * into a single statement.
6109 *
6110 * @see #putExtras
6111 * @see #removeExtra
6112 * @see #getShortExtra(String, short)
6113 */
6114 public Intent putExtra(String name, short value) {
6115 if (mExtras == null) {
6116 mExtras = new Bundle();
6117 }
6118 mExtras.putShort(name, value);
6119 return this;
6120 }
6121
6122 /**
6123 * Add extended data to the intent. The name must include a package
6124 * prefix, for example the app com.android.contacts would use names
6125 * like "com.android.contacts.ShowAll".
6126 *
6127 * @param name The name of the extra data, with package prefix.
6128 * @param value The integer data value.
6129 *
6130 * @return Returns the same Intent object, for chaining multiple calls
6131 * into a single statement.
6132 *
6133 * @see #putExtras
6134 * @see #removeExtra
6135 * @see #getIntExtra(String, int)
6136 */
6137 public Intent putExtra(String name, int value) {
6138 if (mExtras == null) {
6139 mExtras = new Bundle();
6140 }
6141 mExtras.putInt(name, value);
6142 return this;
6143 }
6144
6145 /**
6146 * Add extended data to the intent. The name must include a package
6147 * prefix, for example the app com.android.contacts would use names
6148 * like "com.android.contacts.ShowAll".
6149 *
6150 * @param name The name of the extra data, with package prefix.
6151 * @param value The long data value.
6152 *
6153 * @return Returns the same Intent object, for chaining multiple calls
6154 * into a single statement.
6155 *
6156 * @see #putExtras
6157 * @see #removeExtra
6158 * @see #getLongExtra(String, long)
6159 */
6160 public Intent putExtra(String name, long value) {
6161 if (mExtras == null) {
6162 mExtras = new Bundle();
6163 }
6164 mExtras.putLong(name, value);
6165 return this;
6166 }
6167
6168 /**
6169 * Add extended data to the intent. The name must include a package
6170 * prefix, for example the app com.android.contacts would use names
6171 * like "com.android.contacts.ShowAll".
6172 *
6173 * @param name The name of the extra data, with package prefix.
6174 * @param value The float data value.
6175 *
6176 * @return Returns the same Intent object, for chaining multiple calls
6177 * into a single statement.
6178 *
6179 * @see #putExtras
6180 * @see #removeExtra
6181 * @see #getFloatExtra(String, float)
6182 */
6183 public Intent putExtra(String name, float value) {
6184 if (mExtras == null) {
6185 mExtras = new Bundle();
6186 }
6187 mExtras.putFloat(name, value);
6188 return this;
6189 }
6190
6191 /**
6192 * Add extended data to the intent. The name must include a package
6193 * prefix, for example the app com.android.contacts would use names
6194 * like "com.android.contacts.ShowAll".
6195 *
6196 * @param name The name of the extra data, with package prefix.
6197 * @param value The double data value.
6198 *
6199 * @return Returns the same Intent object, for chaining multiple calls
6200 * into a single statement.
6201 *
6202 * @see #putExtras
6203 * @see #removeExtra
6204 * @see #getDoubleExtra(String, double)
6205 */
6206 public Intent putExtra(String name, double value) {
6207 if (mExtras == null) {
6208 mExtras = new Bundle();
6209 }
6210 mExtras.putDouble(name, value);
6211 return this;
6212 }
6213
6214 /**
6215 * Add extended data to the intent. The name must include a package
6216 * prefix, for example the app com.android.contacts would use names
6217 * like "com.android.contacts.ShowAll".
6218 *
6219 * @param name The name of the extra data, with package prefix.
6220 * @param value The String data value.
6221 *
6222 * @return Returns the same Intent object, for chaining multiple calls
6223 * into a single statement.
6224 *
6225 * @see #putExtras
6226 * @see #removeExtra
6227 * @see #getStringExtra(String)
6228 */
6229 public Intent putExtra(String name, String value) {
6230 if (mExtras == null) {
6231 mExtras = new Bundle();
6232 }
6233 mExtras.putString(name, value);
6234 return this;
6235 }
6236
6237 /**
6238 * Add extended data to the intent. The name must include a package
6239 * prefix, for example the app com.android.contacts would use names
6240 * like "com.android.contacts.ShowAll".
6241 *
6242 * @param name The name of the extra data, with package prefix.
6243 * @param value The CharSequence data value.
6244 *
6245 * @return Returns the same Intent object, for chaining multiple calls
6246 * into a single statement.
6247 *
6248 * @see #putExtras
6249 * @see #removeExtra
6250 * @see #getCharSequenceExtra(String)
6251 */
6252 public Intent putExtra(String name, CharSequence value) {
6253 if (mExtras == null) {
6254 mExtras = new Bundle();
6255 }
6256 mExtras.putCharSequence(name, value);
6257 return this;
6258 }
6259
6260 /**
6261 * Add extended data to the intent. The name must include a package
6262 * prefix, for example the app com.android.contacts would use names
6263 * like "com.android.contacts.ShowAll".
6264 *
6265 * @param name The name of the extra data, with package prefix.
6266 * @param value The Parcelable data value.
6267 *
6268 * @return Returns the same Intent object, for chaining multiple calls
6269 * into a single statement.
6270 *
6271 * @see #putExtras
6272 * @see #removeExtra
6273 * @see #getParcelableExtra(String)
6274 */
6275 public Intent putExtra(String name, Parcelable value) {
6276 if (mExtras == null) {
6277 mExtras = new Bundle();
6278 }
6279 mExtras.putParcelable(name, value);
6280 return this;
6281 }
6282
6283 /**
6284 * Add extended data to the intent. The name must include a package
6285 * prefix, for example the app com.android.contacts would use names
6286 * like "com.android.contacts.ShowAll".
6287 *
6288 * @param name The name of the extra data, with package prefix.
6289 * @param value The Parcelable[] data value.
6290 *
6291 * @return Returns the same Intent object, for chaining multiple calls
6292 * into a single statement.
6293 *
6294 * @see #putExtras
6295 * @see #removeExtra
6296 * @see #getParcelableArrayExtra(String)
6297 */
6298 public Intent putExtra(String name, Parcelable[] value) {
6299 if (mExtras == null) {
6300 mExtras = new Bundle();
6301 }
6302 mExtras.putParcelableArray(name, value);
6303 return this;
6304 }
6305
6306 /**
6307 * Add extended data to the intent. The name must include a package
6308 * prefix, for example the app com.android.contacts would use names
6309 * like "com.android.contacts.ShowAll".
6310 *
6311 * @param name The name of the extra data, with package prefix.
6312 * @param value The ArrayList<Parcelable> data value.
6313 *
6314 * @return Returns the same Intent object, for chaining multiple calls
6315 * into a single statement.
6316 *
6317 * @see #putExtras
6318 * @see #removeExtra
6319 * @see #getParcelableArrayListExtra(String)
6320 */
6321 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6322 if (mExtras == null) {
6323 mExtras = new Bundle();
6324 }
6325 mExtras.putParcelableArrayList(name, value);
6326 return this;
6327 }
6328
6329 /**
6330 * Add extended data to the intent. The name must include a package
6331 * prefix, for example the app com.android.contacts would use names
6332 * like "com.android.contacts.ShowAll".
6333 *
6334 * @param name The name of the extra data, with package prefix.
6335 * @param value The ArrayList<Integer> data value.
6336 *
6337 * @return Returns the same Intent object, for chaining multiple calls
6338 * into a single statement.
6339 *
6340 * @see #putExtras
6341 * @see #removeExtra
6342 * @see #getIntegerArrayListExtra(String)
6343 */
6344 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6345 if (mExtras == null) {
6346 mExtras = new Bundle();
6347 }
6348 mExtras.putIntegerArrayList(name, value);
6349 return this;
6350 }
6351
6352 /**
6353 * Add extended data to the intent. The name must include a package
6354 * prefix, for example the app com.android.contacts would use names
6355 * like "com.android.contacts.ShowAll".
6356 *
6357 * @param name The name of the extra data, with package prefix.
6358 * @param value The ArrayList<String> data value.
6359 *
6360 * @return Returns the same Intent object, for chaining multiple calls
6361 * into a single statement.
6362 *
6363 * @see #putExtras
6364 * @see #removeExtra
6365 * @see #getStringArrayListExtra(String)
6366 */
6367 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6368 if (mExtras == null) {
6369 mExtras = new Bundle();
6370 }
6371 mExtras.putStringArrayList(name, value);
6372 return this;
6373 }
6374
6375 /**
6376 * Add extended data to the intent. The name must include a package
6377 * prefix, for example the app com.android.contacts would use names
6378 * like "com.android.contacts.ShowAll".
6379 *
6380 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006381 * @param value The ArrayList<CharSequence> data value.
6382 *
6383 * @return Returns the same Intent object, for chaining multiple calls
6384 * into a single statement.
6385 *
6386 * @see #putExtras
6387 * @see #removeExtra
6388 * @see #getCharSequenceArrayListExtra(String)
6389 */
6390 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6391 if (mExtras == null) {
6392 mExtras = new Bundle();
6393 }
6394 mExtras.putCharSequenceArrayList(name, value);
6395 return this;
6396 }
6397
6398 /**
6399 * Add extended data to the intent. The name must include a package
6400 * prefix, for example the app com.android.contacts would use names
6401 * like "com.android.contacts.ShowAll".
6402 *
6403 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 * @param value The Serializable data value.
6405 *
6406 * @return Returns the same Intent object, for chaining multiple calls
6407 * into a single statement.
6408 *
6409 * @see #putExtras
6410 * @see #removeExtra
6411 * @see #getSerializableExtra(String)
6412 */
6413 public Intent putExtra(String name, Serializable value) {
6414 if (mExtras == null) {
6415 mExtras = new Bundle();
6416 }
6417 mExtras.putSerializable(name, value);
6418 return this;
6419 }
6420
6421 /**
6422 * Add extended data to the intent. The name must include a package
6423 * prefix, for example the app com.android.contacts would use names
6424 * like "com.android.contacts.ShowAll".
6425 *
6426 * @param name The name of the extra data, with package prefix.
6427 * @param value The boolean array data value.
6428 *
6429 * @return Returns the same Intent object, for chaining multiple calls
6430 * into a single statement.
6431 *
6432 * @see #putExtras
6433 * @see #removeExtra
6434 * @see #getBooleanArrayExtra(String)
6435 */
6436 public Intent putExtra(String name, boolean[] value) {
6437 if (mExtras == null) {
6438 mExtras = new Bundle();
6439 }
6440 mExtras.putBooleanArray(name, value);
6441 return this;
6442 }
6443
6444 /**
6445 * Add extended data to the intent. The name must include a package
6446 * prefix, for example the app com.android.contacts would use names
6447 * like "com.android.contacts.ShowAll".
6448 *
6449 * @param name The name of the extra data, with package prefix.
6450 * @param value The byte array data value.
6451 *
6452 * @return Returns the same Intent object, for chaining multiple calls
6453 * into a single statement.
6454 *
6455 * @see #putExtras
6456 * @see #removeExtra
6457 * @see #getByteArrayExtra(String)
6458 */
6459 public Intent putExtra(String name, byte[] value) {
6460 if (mExtras == null) {
6461 mExtras = new Bundle();
6462 }
6463 mExtras.putByteArray(name, value);
6464 return this;
6465 }
6466
6467 /**
6468 * Add extended data to the intent. The name must include a package
6469 * prefix, for example the app com.android.contacts would use names
6470 * like "com.android.contacts.ShowAll".
6471 *
6472 * @param name The name of the extra data, with package prefix.
6473 * @param value The short array data value.
6474 *
6475 * @return Returns the same Intent object, for chaining multiple calls
6476 * into a single statement.
6477 *
6478 * @see #putExtras
6479 * @see #removeExtra
6480 * @see #getShortArrayExtra(String)
6481 */
6482 public Intent putExtra(String name, short[] value) {
6483 if (mExtras == null) {
6484 mExtras = new Bundle();
6485 }
6486 mExtras.putShortArray(name, value);
6487 return this;
6488 }
6489
6490 /**
6491 * Add extended data to the intent. The name must include a package
6492 * prefix, for example the app com.android.contacts would use names
6493 * like "com.android.contacts.ShowAll".
6494 *
6495 * @param name The name of the extra data, with package prefix.
6496 * @param value The char array data value.
6497 *
6498 * @return Returns the same Intent object, for chaining multiple calls
6499 * into a single statement.
6500 *
6501 * @see #putExtras
6502 * @see #removeExtra
6503 * @see #getCharArrayExtra(String)
6504 */
6505 public Intent putExtra(String name, char[] value) {
6506 if (mExtras == null) {
6507 mExtras = new Bundle();
6508 }
6509 mExtras.putCharArray(name, value);
6510 return this;
6511 }
6512
6513 /**
6514 * Add extended data to the intent. The name must include a package
6515 * prefix, for example the app com.android.contacts would use names
6516 * like "com.android.contacts.ShowAll".
6517 *
6518 * @param name The name of the extra data, with package prefix.
6519 * @param value The int array data value.
6520 *
6521 * @return Returns the same Intent object, for chaining multiple calls
6522 * into a single statement.
6523 *
6524 * @see #putExtras
6525 * @see #removeExtra
6526 * @see #getIntArrayExtra(String)
6527 */
6528 public Intent putExtra(String name, int[] value) {
6529 if (mExtras == null) {
6530 mExtras = new Bundle();
6531 }
6532 mExtras.putIntArray(name, value);
6533 return this;
6534 }
6535
6536 /**
6537 * Add extended data to the intent. The name must include a package
6538 * prefix, for example the app com.android.contacts would use names
6539 * like "com.android.contacts.ShowAll".
6540 *
6541 * @param name The name of the extra data, with package prefix.
6542 * @param value The byte array data value.
6543 *
6544 * @return Returns the same Intent object, for chaining multiple calls
6545 * into a single statement.
6546 *
6547 * @see #putExtras
6548 * @see #removeExtra
6549 * @see #getLongArrayExtra(String)
6550 */
6551 public Intent putExtra(String name, long[] value) {
6552 if (mExtras == null) {
6553 mExtras = new Bundle();
6554 }
6555 mExtras.putLongArray(name, value);
6556 return this;
6557 }
6558
6559 /**
6560 * Add extended data to the intent. The name must include a package
6561 * prefix, for example the app com.android.contacts would use names
6562 * like "com.android.contacts.ShowAll".
6563 *
6564 * @param name The name of the extra data, with package prefix.
6565 * @param value The float array data value.
6566 *
6567 * @return Returns the same Intent object, for chaining multiple calls
6568 * into a single statement.
6569 *
6570 * @see #putExtras
6571 * @see #removeExtra
6572 * @see #getFloatArrayExtra(String)
6573 */
6574 public Intent putExtra(String name, float[] value) {
6575 if (mExtras == null) {
6576 mExtras = new Bundle();
6577 }
6578 mExtras.putFloatArray(name, value);
6579 return this;
6580 }
6581
6582 /**
6583 * Add extended data to the intent. The name must include a package
6584 * prefix, for example the app com.android.contacts would use names
6585 * like "com.android.contacts.ShowAll".
6586 *
6587 * @param name The name of the extra data, with package prefix.
6588 * @param value The double array data value.
6589 *
6590 * @return Returns the same Intent object, for chaining multiple calls
6591 * into a single statement.
6592 *
6593 * @see #putExtras
6594 * @see #removeExtra
6595 * @see #getDoubleArrayExtra(String)
6596 */
6597 public Intent putExtra(String name, double[] value) {
6598 if (mExtras == null) {
6599 mExtras = new Bundle();
6600 }
6601 mExtras.putDoubleArray(name, value);
6602 return this;
6603 }
6604
6605 /**
6606 * Add extended data to the intent. The name must include a package
6607 * prefix, for example the app com.android.contacts would use names
6608 * like "com.android.contacts.ShowAll".
6609 *
6610 * @param name The name of the extra data, with package prefix.
6611 * @param value The String array data value.
6612 *
6613 * @return Returns the same Intent object, for chaining multiple calls
6614 * into a single statement.
6615 *
6616 * @see #putExtras
6617 * @see #removeExtra
6618 * @see #getStringArrayExtra(String)
6619 */
6620 public Intent putExtra(String name, String[] value) {
6621 if (mExtras == null) {
6622 mExtras = new Bundle();
6623 }
6624 mExtras.putStringArray(name, value);
6625 return this;
6626 }
6627
6628 /**
6629 * Add extended data to the intent. The name must include a package
6630 * prefix, for example the app com.android.contacts would use names
6631 * like "com.android.contacts.ShowAll".
6632 *
6633 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006634 * @param value The CharSequence array data value.
6635 *
6636 * @return Returns the same Intent object, for chaining multiple calls
6637 * into a single statement.
6638 *
6639 * @see #putExtras
6640 * @see #removeExtra
6641 * @see #getCharSequenceArrayExtra(String)
6642 */
6643 public Intent putExtra(String name, CharSequence[] value) {
6644 if (mExtras == null) {
6645 mExtras = new Bundle();
6646 }
6647 mExtras.putCharSequenceArray(name, value);
6648 return this;
6649 }
6650
6651 /**
6652 * Add extended data to the intent. The name must include a package
6653 * prefix, for example the app com.android.contacts would use names
6654 * like "com.android.contacts.ShowAll".
6655 *
6656 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006657 * @param value The Bundle data value.
6658 *
6659 * @return Returns the same Intent object, for chaining multiple calls
6660 * into a single statement.
6661 *
6662 * @see #putExtras
6663 * @see #removeExtra
6664 * @see #getBundleExtra(String)
6665 */
6666 public Intent putExtra(String name, Bundle value) {
6667 if (mExtras == null) {
6668 mExtras = new Bundle();
6669 }
6670 mExtras.putBundle(name, value);
6671 return this;
6672 }
6673
6674 /**
6675 * Add extended data to the intent. The name must include a package
6676 * prefix, for example the app com.android.contacts would use names
6677 * like "com.android.contacts.ShowAll".
6678 *
6679 * @param name The name of the extra data, with package prefix.
6680 * @param value The IBinder data value.
6681 *
6682 * @return Returns the same Intent object, for chaining multiple calls
6683 * into a single statement.
6684 *
6685 * @see #putExtras
6686 * @see #removeExtra
6687 * @see #getIBinderExtra(String)
6688 *
6689 * @deprecated
6690 * @hide
6691 */
6692 @Deprecated
6693 public Intent putExtra(String name, IBinder value) {
6694 if (mExtras == null) {
6695 mExtras = new Bundle();
6696 }
6697 mExtras.putIBinder(name, value);
6698 return this;
6699 }
6700
6701 /**
6702 * Copy all extras in 'src' in to this intent.
6703 *
6704 * @param src Contains the extras to copy.
6705 *
6706 * @see #putExtra
6707 */
6708 public Intent putExtras(Intent src) {
6709 if (src.mExtras != null) {
6710 if (mExtras == null) {
6711 mExtras = new Bundle(src.mExtras);
6712 } else {
6713 mExtras.putAll(src.mExtras);
6714 }
6715 }
6716 return this;
6717 }
6718
6719 /**
6720 * Add a set of extended data to the intent. The keys must include a package
6721 * prefix, for example the app com.android.contacts would use names
6722 * like "com.android.contacts.ShowAll".
6723 *
6724 * @param extras The Bundle of extras to add to this intent.
6725 *
6726 * @see #putExtra
6727 * @see #removeExtra
6728 */
6729 public Intent putExtras(Bundle extras) {
6730 if (mExtras == null) {
6731 mExtras = new Bundle();
6732 }
6733 mExtras.putAll(extras);
6734 return this;
6735 }
6736
6737 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006738 * Completely replace the extras in the Intent with the extras in the
6739 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006740 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006741 * @param src The exact extras contained in this Intent are copied
6742 * into the target intent, replacing any that were previously there.
6743 */
6744 public Intent replaceExtras(Intent src) {
6745 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6746 return this;
6747 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006748
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006749 /**
6750 * Completely replace the extras in the Intent with the given Bundle of
6751 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006752 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006753 * @param extras The new set of extras in the Intent, or null to erase
6754 * all extras.
6755 */
6756 public Intent replaceExtras(Bundle extras) {
6757 mExtras = extras != null ? new Bundle(extras) : null;
6758 return this;
6759 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006760
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006761 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006762 * Remove extended data from the intent.
6763 *
6764 * @see #putExtra
6765 */
6766 public void removeExtra(String name) {
6767 if (mExtras != null) {
6768 mExtras.remove(name);
6769 if (mExtras.size() == 0) {
6770 mExtras = null;
6771 }
6772 }
6773 }
6774
6775 /**
6776 * Set special flags controlling how this intent is handled. Most values
6777 * here depend on the type of component being executed by the Intent,
6778 * specifically the FLAG_ACTIVITY_* flags are all for use with
6779 * {@link Context#startActivity Context.startActivity()} and the
6780 * FLAG_RECEIVER_* flags are all for use with
6781 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6782 *
Scott Main7aee61f2011-02-08 11:25:01 -08006783 * <p>See the
6784 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6785 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006786 * the behavior of your application.
6787 *
6788 * @param flags The desired flags.
6789 *
6790 * @return Returns the same Intent object, for chaining multiple calls
6791 * into a single statement.
6792 *
6793 * @see #getFlags
6794 * @see #addFlags
6795 *
6796 * @see #FLAG_GRANT_READ_URI_PERMISSION
6797 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006798 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6799 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006800 * @see #FLAG_DEBUG_LOG_RESOLUTION
6801 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006802 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006803 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006804 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006805 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006806 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6807 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006808 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006809 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006810 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006811 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006812 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006813 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006814 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006815 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6816 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006817 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006818 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006819 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006820 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6821 */
6822 public Intent setFlags(int flags) {
6823 mFlags = flags;
6824 return this;
6825 }
6826
6827 /**
6828 * Add additional flags to the intent (or with existing flags
6829 * value).
6830 *
6831 * @param flags The new flags to set.
6832 *
6833 * @return Returns the same Intent object, for chaining multiple calls
6834 * into a single statement.
6835 *
6836 * @see #setFlags
6837 */
6838 public Intent addFlags(int flags) {
6839 mFlags |= flags;
6840 return this;
6841 }
6842
6843 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006844 * (Usually optional) Set an explicit application package name that limits
6845 * the components this Intent will resolve to. If left to the default
6846 * value of null, all components in all applications will considered.
6847 * If non-null, the Intent can only match the components in the given
6848 * application package.
6849 *
6850 * @param packageName The name of the application package to handle the
6851 * intent, or null to allow any application package.
6852 *
6853 * @return Returns the same Intent object, for chaining multiple calls
6854 * into a single statement.
6855 *
6856 * @see #getPackage
6857 * @see #resolveActivity
6858 */
6859 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006860 if (packageName != null && mSelector != null) {
6861 throw new IllegalArgumentException(
6862 "Can't set package name when selector is already set");
6863 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006864 mPackage = packageName;
6865 return this;
6866 }
6867
6868 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006869 * (Usually optional) Explicitly set the component to handle the intent.
6870 * If left with the default value of null, the system will determine the
6871 * appropriate class to use based on the other fields (action, data,
6872 * type, categories) in the Intent. If this class is defined, the
6873 * specified class will always be used regardless of the other fields. You
6874 * should only set this value when you know you absolutely want a specific
6875 * class to be used; otherwise it is better to let the system find the
6876 * appropriate class so that you will respect the installed applications
6877 * and user preferences.
6878 *
6879 * @param component The name of the application component to handle the
6880 * intent, or null to let the system find one for you.
6881 *
6882 * @return Returns the same Intent object, for chaining multiple calls
6883 * into a single statement.
6884 *
6885 * @see #setClass
6886 * @see #setClassName(Context, String)
6887 * @see #setClassName(String, String)
6888 * @see #getComponent
6889 * @see #resolveActivity
6890 */
6891 public Intent setComponent(ComponentName component) {
6892 mComponent = component;
6893 return this;
6894 }
6895
6896 /**
6897 * Convenience for calling {@link #setComponent} with an
6898 * explicit class name.
6899 *
6900 * @param packageContext A Context of the application package implementing
6901 * this class.
6902 * @param className The name of a class inside of the application package
6903 * that will be used as the component for this Intent.
6904 *
6905 * @return Returns the same Intent object, for chaining multiple calls
6906 * into a single statement.
6907 *
6908 * @see #setComponent
6909 * @see #setClass
6910 */
6911 public Intent setClassName(Context packageContext, String className) {
6912 mComponent = new ComponentName(packageContext, className);
6913 return this;
6914 }
6915
6916 /**
6917 * Convenience for calling {@link #setComponent} with an
6918 * explicit application package name and class name.
6919 *
6920 * @param packageName The name of the package implementing the desired
6921 * component.
6922 * @param className The name of a class inside of the application package
6923 * that will be used as the component for this Intent.
6924 *
6925 * @return Returns the same Intent object, for chaining multiple calls
6926 * into a single statement.
6927 *
6928 * @see #setComponent
6929 * @see #setClass
6930 */
6931 public Intent setClassName(String packageName, String className) {
6932 mComponent = new ComponentName(packageName, className);
6933 return this;
6934 }
6935
6936 /**
6937 * Convenience for calling {@link #setComponent(ComponentName)} with the
6938 * name returned by a {@link Class} object.
6939 *
6940 * @param packageContext A Context of the application package implementing
6941 * this class.
6942 * @param cls The class name to set, equivalent to
6943 * <code>setClassName(context, cls.getName())</code>.
6944 *
6945 * @return Returns the same Intent object, for chaining multiple calls
6946 * into a single statement.
6947 *
6948 * @see #setComponent
6949 */
6950 public Intent setClass(Context packageContext, Class<?> cls) {
6951 mComponent = new ComponentName(packageContext, cls);
6952 return this;
6953 }
6954
6955 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006956 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6957 * used as a hint to the receiver for animations and the like. Null means that there
6958 * is no source bounds.
6959 */
6960 public void setSourceBounds(Rect r) {
6961 if (r != null) {
6962 mSourceBounds = new Rect(r);
6963 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006964 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006965 }
6966 }
6967
Tor Norbyed9273d62013-05-30 15:59:53 -07006968 /** @hide */
6969 @IntDef(flag = true,
6970 value = {
6971 FILL_IN_ACTION,
6972 FILL_IN_DATA,
6973 FILL_IN_CATEGORIES,
6974 FILL_IN_COMPONENT,
6975 FILL_IN_PACKAGE,
6976 FILL_IN_SOURCE_BOUNDS,
6977 FILL_IN_SELECTOR,
6978 FILL_IN_CLIP_DATA
6979 })
6980 @Retention(RetentionPolicy.SOURCE)
6981 public @interface FillInFlags {}
6982
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006983 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006984 * Use with {@link #fillIn} to allow the current action value to be
6985 * overwritten, even if it is already set.
6986 */
6987 public static final int FILL_IN_ACTION = 1<<0;
6988
6989 /**
6990 * Use with {@link #fillIn} to allow the current data or type value
6991 * overwritten, even if it is already set.
6992 */
6993 public static final int FILL_IN_DATA = 1<<1;
6994
6995 /**
6996 * Use with {@link #fillIn} to allow the current categories to be
6997 * overwritten, even if they are already set.
6998 */
6999 public static final int FILL_IN_CATEGORIES = 1<<2;
7000
7001 /**
7002 * Use with {@link #fillIn} to allow the current component value to be
7003 * overwritten, even if it is already set.
7004 */
7005 public static final int FILL_IN_COMPONENT = 1<<3;
7006
7007 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007008 * Use with {@link #fillIn} to allow the current package value to be
7009 * overwritten, even if it is already set.
7010 */
7011 public static final int FILL_IN_PACKAGE = 1<<4;
7012
7013 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007014 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007015 * overwritten, even if it is already set.
7016 */
7017 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
7018
7019 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007020 * Use with {@link #fillIn} to allow the current selector to be
7021 * overwritten, even if it is already set.
7022 */
7023 public static final int FILL_IN_SELECTOR = 1<<6;
7024
7025 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007026 * Use with {@link #fillIn} to allow the current ClipData to be
7027 * overwritten, even if it is already set.
7028 */
7029 public static final int FILL_IN_CLIP_DATA = 1<<7;
7030
7031 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007032 * Copy the contents of <var>other</var> in to this object, but only
7033 * where fields are not defined by this object. For purposes of a field
7034 * being defined, the following pieces of data in the Intent are
7035 * considered to be separate fields:
7036 *
7037 * <ul>
7038 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08007039 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007040 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
7041 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007042 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007043 * <li> component, as set by {@link #setComponent(ComponentName)} or
7044 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007045 * <li> source bounds, as set by {@link #setSourceBounds}.
7046 * <li> selector, as set by {@link #setSelector(Intent)}.
7047 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007048 * <li> each top-level name in the associated extras.
7049 * </ul>
7050 *
7051 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007052 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007053 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7054 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
7055 * the restriction where the corresponding field will not be replaced if
7056 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007057 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007058 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
7059 * is explicitly specified. The selector will only be copied if
7060 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07007061 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007062 * <p>For example, consider Intent A with {data="foo", categories="bar"}
7063 * and Intent B with {action="gotit", data-type="some/thing",
7064 * categories="one","two"}.
7065 *
7066 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
7067 * containing: {action="gotit", data-type="some/thing",
7068 * categories="bar"}.
7069 *
7070 * @param other Another Intent whose values are to be used to fill in
7071 * the current one.
7072 * @param flags Options to control which fields can be filled in.
7073 *
7074 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007075 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07007076 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7077 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
7078 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007079 */
Tor Norbyed9273d62013-05-30 15:59:53 -07007080 @FillInFlags
7081 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007082 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007083 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007084 if (other.mAction != null
7085 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007086 mAction = other.mAction;
7087 changes |= FILL_IN_ACTION;
7088 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007089 if ((other.mData != null || other.mType != null)
7090 && ((mData == null && mType == null)
7091 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007092 mData = other.mData;
7093 mType = other.mType;
7094 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007095 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007096 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007097 if (other.mCategories != null
7098 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007099 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007100 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007101 }
7102 changes |= FILL_IN_CATEGORIES;
7103 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007104 if (other.mPackage != null
7105 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007106 // Only do this if mSelector is not set.
7107 if (mSelector == null) {
7108 mPackage = other.mPackage;
7109 changes |= FILL_IN_PACKAGE;
7110 }
7111 }
7112 // Selector is special: it can only be set if explicitly allowed,
7113 // for the same reason as the component name.
7114 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
7115 if (mPackage == null) {
7116 mSelector = new Intent(other.mSelector);
7117 mPackage = null;
7118 changes |= FILL_IN_SELECTOR;
7119 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007120 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007121 if (other.mClipData != null
7122 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
7123 mClipData = other.mClipData;
7124 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007125 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007126 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007127 // Component is special: it can -only- be set if explicitly allowed,
7128 // since otherwise the sender could force the intent somewhere the
7129 // originator didn't intend.
7130 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007131 mComponent = other.mComponent;
7132 changes |= FILL_IN_COMPONENT;
7133 }
7134 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007135 if (other.mSourceBounds != null
7136 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
7137 mSourceBounds = new Rect(other.mSourceBounds);
7138 changes |= FILL_IN_SOURCE_BOUNDS;
7139 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007140 if (mExtras == null) {
7141 if (other.mExtras != null) {
7142 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007143 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007144 }
7145 } else if (other.mExtras != null) {
7146 try {
7147 Bundle newb = new Bundle(other.mExtras);
7148 newb.putAll(mExtras);
7149 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007150 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007151 } catch (RuntimeException e) {
7152 // Modifying the extras can cause us to unparcel the contents
7153 // of the bundle, and if we do this in the system process that
7154 // may fail. We really should handle this (i.e., the Bundle
7155 // impl shouldn't be on top of a plain map), but for now just
7156 // ignore it and keep the original contents. :(
7157 Log.w("Intent", "Failure filling in extras", e);
7158 }
7159 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007160 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
7161 && other.mContentUserHint != UserHandle.USER_CURRENT) {
7162 mContentUserHint = other.mContentUserHint;
7163 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007164 return changes;
7165 }
7166
7167 /**
7168 * Wrapper class holding an Intent and implementing comparisons on it for
7169 * the purpose of filtering. The class implements its
7170 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
7171 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
7172 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
7173 * on the wrapped Intent.
7174 */
7175 public static final class FilterComparison {
7176 private final Intent mIntent;
7177 private final int mHashCode;
7178
7179 public FilterComparison(Intent intent) {
7180 mIntent = intent;
7181 mHashCode = intent.filterHashCode();
7182 }
7183
7184 /**
7185 * Return the Intent that this FilterComparison represents.
7186 * @return Returns the Intent held by the FilterComparison. Do
7187 * not modify!
7188 */
7189 public Intent getIntent() {
7190 return mIntent;
7191 }
7192
7193 @Override
7194 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007195 if (obj instanceof FilterComparison) {
7196 Intent other = ((FilterComparison)obj).mIntent;
7197 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007198 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007199 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007200 }
7201
7202 @Override
7203 public int hashCode() {
7204 return mHashCode;
7205 }
7206 }
7207
7208 /**
7209 * Determine if two intents are the same for the purposes of intent
7210 * resolution (filtering). That is, if their action, data, type,
7211 * class, and categories are the same. This does <em>not</em> compare
7212 * any extra data included in the intents.
7213 *
7214 * @param other The other Intent to compare against.
7215 *
7216 * @return Returns true if action, data, type, class, and categories
7217 * are the same.
7218 */
7219 public boolean filterEquals(Intent other) {
7220 if (other == null) {
7221 return false;
7222 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07007223 if (!Objects.equals(this.mAction, other.mAction)) return false;
7224 if (!Objects.equals(this.mData, other.mData)) return false;
7225 if (!Objects.equals(this.mType, other.mType)) return false;
7226 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
7227 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
7228 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007229
7230 return true;
7231 }
7232
7233 /**
7234 * Generate hash code that matches semantics of filterEquals().
7235 *
7236 * @return Returns the hash value of the action, data, type, class, and
7237 * categories.
7238 *
7239 * @see #filterEquals
7240 */
7241 public int filterHashCode() {
7242 int code = 0;
7243 if (mAction != null) {
7244 code += mAction.hashCode();
7245 }
7246 if (mData != null) {
7247 code += mData.hashCode();
7248 }
7249 if (mType != null) {
7250 code += mType.hashCode();
7251 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007252 if (mPackage != null) {
7253 code += mPackage.hashCode();
7254 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007255 if (mComponent != null) {
7256 code += mComponent.hashCode();
7257 }
7258 if (mCategories != null) {
7259 code += mCategories.hashCode();
7260 }
7261 return code;
7262 }
7263
7264 @Override
7265 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007266 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007267
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007268 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007269 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007270 b.append(" }");
7271
7272 return b.toString();
7273 }
7274
7275 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007276 public String toInsecureString() {
7277 StringBuilder b = new StringBuilder(128);
7278
7279 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007280 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007281 b.append(" }");
7282
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007283 return b.toString();
7284 }
Romain Guy4969af72009-06-17 10:53:19 -07007285
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007286 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007287 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007288 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007289
7290 b.append("Intent { ");
7291 toShortString(b, false, true, true, true);
7292 b.append(" }");
7293
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007294 return b.toString();
7295 }
7296
7297 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007298 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
7299 StringBuilder b = new StringBuilder(128);
7300 toShortString(b, secure, comp, extras, clip);
7301 return b.toString();
7302 }
7303
7304 /** @hide */
7305 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
7306 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007307 boolean first = true;
7308 if (mAction != null) {
7309 b.append("act=").append(mAction);
7310 first = false;
7311 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007312 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007313 if (!first) {
7314 b.append(' ');
7315 }
7316 first = false;
7317 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007318 for (int i=0; i<mCategories.size(); i++) {
7319 if (i > 0) b.append(',');
7320 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007321 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007322 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007323 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007324 if (mData != null) {
7325 if (!first) {
7326 b.append(' ');
7327 }
7328 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007329 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007330 if (secure) {
7331 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007332 } else {
7333 b.append(mData);
7334 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007335 }
7336 if (mType != null) {
7337 if (!first) {
7338 b.append(' ');
7339 }
7340 first = false;
7341 b.append("typ=").append(mType);
7342 }
7343 if (mFlags != 0) {
7344 if (!first) {
7345 b.append(' ');
7346 }
7347 first = false;
7348 b.append("flg=0x").append(Integer.toHexString(mFlags));
7349 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007350 if (mPackage != null) {
7351 if (!first) {
7352 b.append(' ');
7353 }
7354 first = false;
7355 b.append("pkg=").append(mPackage);
7356 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007357 if (comp && mComponent != null) {
7358 if (!first) {
7359 b.append(' ');
7360 }
7361 first = false;
7362 b.append("cmp=").append(mComponent.flattenToShortString());
7363 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007364 if (mSourceBounds != null) {
7365 if (!first) {
7366 b.append(' ');
7367 }
7368 first = false;
7369 b.append("bnds=").append(mSourceBounds.toShortString());
7370 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007371 if (mClipData != null) {
7372 if (!first) {
7373 b.append(' ');
7374 }
7375 first = false;
7376 if (clip) {
7377 b.append("clip={");
7378 mClipData.toShortString(b);
7379 b.append('}');
7380 } else {
7381 b.append("(has clip)");
7382 }
7383 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007384 if (extras && mExtras != null) {
7385 if (!first) {
7386 b.append(' ');
7387 }
7388 first = false;
7389 b.append("(has extras)");
7390 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007391 if (mContentUserHint != UserHandle.USER_CURRENT) {
7392 if (!first) {
7393 b.append(' ');
7394 }
7395 first = false;
7396 b.append("u=").append(mContentUserHint);
7397 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007398 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007399 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007400 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007401 b.append("}");
7402 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007403 }
7404
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007405 /**
7406 * Call {@link #toUri} with 0 flags.
7407 * @deprecated Use {@link #toUri} instead.
7408 */
7409 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007410 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007411 return toUri(0);
7412 }
7413
7414 /**
7415 * Convert this Intent into a String holding a URI representation of it.
7416 * The returned URI string has been properly URI encoded, so it can be
7417 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7418 * Intent's data as the base URI, with an additional fragment describing
7419 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007420 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007421 * <p>You can convert the returned string back to an Intent with
7422 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007423 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007424 * @param flags Additional operating flags. Either 0,
7425 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007426 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007427 * @return Returns a URI encoding URI string describing the entire contents
7428 * of the Intent.
7429 */
7430 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007431 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007432 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
7433 if (mPackage == null) {
7434 throw new IllegalArgumentException(
7435 "Intent must include an explicit package name to build an android-app: "
7436 + this);
7437 }
7438 uri.append("android-app://");
7439 uri.append(mPackage);
7440 String scheme = null;
7441 if (mData != null) {
7442 scheme = mData.getScheme();
7443 if (scheme != null) {
7444 uri.append('/');
7445 uri.append(scheme);
7446 String authority = mData.getEncodedAuthority();
7447 if (authority != null) {
7448 uri.append('/');
7449 uri.append(authority);
7450 String path = mData.getEncodedPath();
7451 if (path != null) {
7452 uri.append(path);
7453 }
7454 String queryParams = mData.getEncodedQuery();
7455 if (queryParams != null) {
7456 uri.append('?');
7457 uri.append(queryParams);
7458 }
7459 String fragment = mData.getEncodedFragment();
7460 if (fragment != null) {
7461 uri.append('#');
7462 uri.append(fragment);
7463 }
7464 }
7465 }
7466 }
7467 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
7468 mPackage, flags);
7469 return uri.toString();
7470 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007471 String scheme = null;
7472 if (mData != null) {
7473 String data = mData.toString();
7474 if ((flags&URI_INTENT_SCHEME) != 0) {
7475 final int N = data.length();
7476 for (int i=0; i<N; i++) {
7477 char c = data.charAt(i);
7478 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7479 || c == '.' || c == '-') {
7480 continue;
7481 }
7482 if (c == ':' && i > 0) {
7483 // Valid scheme.
7484 scheme = data.substring(0, i);
7485 uri.append("intent:");
7486 data = data.substring(i+1);
7487 break;
7488 }
Tom Taylord4a47292009-12-21 13:59:18 -08007489
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007490 // No scheme.
7491 break;
7492 }
7493 }
7494 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007495
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007496 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7497 uri.append("intent:");
7498 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007499
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007500 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007501
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007502 return uri.toString();
7503 }
7504
7505 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
7506 String defPackage, int flags) {
7507 StringBuilder frag = new StringBuilder(128);
7508
7509 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007510 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08007511 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007512 // Note that for now we are not going to try to handle the
7513 // data part; not clear how to represent this as a URI, and
7514 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007515 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
7516 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007517 }
7518
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007519 if (frag.length() > 0) {
7520 uri.append("#Intent;");
7521 uri.append(frag);
7522 uri.append("end");
7523 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007524 }
7525
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007526 private void toUriInner(StringBuilder uri, String scheme, String defAction,
7527 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007528 if (scheme != null) {
7529 uri.append("scheme=").append(scheme).append(';');
7530 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007531 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007532 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007533 }
7534 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007535 for (int i=0; i<mCategories.size(); i++) {
7536 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007537 }
7538 }
7539 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007540 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007541 }
7542 if (mFlags != 0) {
7543 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7544 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007545 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007546 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7547 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007548 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007549 uri.append("component=").append(Uri.encode(
7550 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007551 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007552 if (mSourceBounds != null) {
7553 uri.append("sourceBounds=")
7554 .append(Uri.encode(mSourceBounds.flattenToString()))
7555 .append(';');
7556 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007557 if (mExtras != null) {
7558 for (String key : mExtras.keySet()) {
7559 final Object value = mExtras.get(key);
7560 char entryType =
7561 value instanceof String ? 'S' :
7562 value instanceof Boolean ? 'B' :
7563 value instanceof Byte ? 'b' :
7564 value instanceof Character ? 'c' :
7565 value instanceof Double ? 'd' :
7566 value instanceof Float ? 'f' :
7567 value instanceof Integer ? 'i' :
7568 value instanceof Long ? 'l' :
7569 value instanceof Short ? 's' :
7570 '\0';
7571
7572 if (entryType != '\0') {
7573 uri.append(entryType);
7574 uri.append('.');
7575 uri.append(Uri.encode(key));
7576 uri.append('=');
7577 uri.append(Uri.encode(value.toString()));
7578 uri.append(';');
7579 }
7580 }
7581 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007582 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007583
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007584 public int describeContents() {
7585 return (mExtras != null) ? mExtras.describeContents() : 0;
7586 }
7587
7588 public void writeToParcel(Parcel out, int flags) {
7589 out.writeString(mAction);
7590 Uri.writeToParcel(out, mData);
7591 out.writeString(mType);
7592 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007593 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007594 ComponentName.writeToParcel(mComponent, out);
7595
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007596 if (mSourceBounds != null) {
7597 out.writeInt(1);
7598 mSourceBounds.writeToParcel(out, flags);
7599 } else {
7600 out.writeInt(0);
7601 }
7602
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007603 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007604 final int N = mCategories.size();
7605 out.writeInt(N);
7606 for (int i=0; i<N; i++) {
7607 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007608 }
7609 } else {
7610 out.writeInt(0);
7611 }
7612
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007613 if (mSelector != null) {
7614 out.writeInt(1);
7615 mSelector.writeToParcel(out, flags);
7616 } else {
7617 out.writeInt(0);
7618 }
7619
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007620 if (mClipData != null) {
7621 out.writeInt(1);
7622 mClipData.writeToParcel(out, flags);
7623 } else {
7624 out.writeInt(0);
7625 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007626 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007627 out.writeBundle(mExtras);
7628 }
7629
7630 public static final Parcelable.Creator<Intent> CREATOR
7631 = new Parcelable.Creator<Intent>() {
7632 public Intent createFromParcel(Parcel in) {
7633 return new Intent(in);
7634 }
7635 public Intent[] newArray(int size) {
7636 return new Intent[size];
7637 }
7638 };
7639
Dianne Hackborneb034652009-09-07 00:49:58 -07007640 /** @hide */
7641 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007642 readFromParcel(in);
7643 }
7644
7645 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007646 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007647 mData = Uri.CREATOR.createFromParcel(in);
7648 mType = in.readString();
7649 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007650 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007651 mComponent = ComponentName.readFromParcel(in);
7652
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007653 if (in.readInt() != 0) {
7654 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7655 }
7656
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007657 int N = in.readInt();
7658 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007659 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007660 int i;
7661 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007662 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007663 }
7664 } else {
7665 mCategories = null;
7666 }
7667
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007668 if (in.readInt() != 0) {
7669 mSelector = new Intent(in);
7670 }
7671
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007672 if (in.readInt() != 0) {
7673 mClipData = new ClipData(in);
7674 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007675 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007676 mExtras = in.readBundle();
7677 }
7678
7679 /**
7680 * Parses the "intent" element (and its children) from XML and instantiates
7681 * an Intent object. The given XML parser should be located at the tag
7682 * where parsing should start (often named "intent"), from which the
7683 * basic action, data, type, and package and class name will be
7684 * retrieved. The function will then parse in to any child elements,
7685 * looking for <category android:name="xxx"> tags to add categories and
7686 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7687 * to the intent.
7688 *
7689 * @param resources The Resources to use when inflating resources.
7690 * @param parser The XML parser pointing at an "intent" tag.
7691 * @param attrs The AttributeSet interface for retrieving extended
7692 * attribute data at the current <var>parser</var> location.
7693 * @return An Intent object matching the XML data.
7694 * @throws XmlPullParserException If there was an XML parsing error.
7695 * @throws IOException If there was an I/O error.
7696 */
7697 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7698 throws XmlPullParserException, IOException {
7699 Intent intent = new Intent();
7700
7701 TypedArray sa = resources.obtainAttributes(attrs,
7702 com.android.internal.R.styleable.Intent);
7703
7704 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7705
7706 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7707 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7708 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7709
7710 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7711 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7712 if (packageName != null && className != null) {
7713 intent.setComponent(new ComponentName(packageName, className));
7714 }
7715
7716 sa.recycle();
7717
7718 int outerDepth = parser.getDepth();
7719 int type;
7720 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7721 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7722 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7723 continue;
7724 }
7725
7726 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007727 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007728 sa = resources.obtainAttributes(attrs,
7729 com.android.internal.R.styleable.IntentCategory);
7730 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7731 sa.recycle();
7732
7733 if (cat != null) {
7734 intent.addCategory(cat);
7735 }
7736 XmlUtils.skipCurrentTag(parser);
7737
Craig Mautner21d24a22014-04-23 11:45:37 -07007738 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007739 if (intent.mExtras == null) {
7740 intent.mExtras = new Bundle();
7741 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007742 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007743 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007744
7745 } else {
7746 XmlUtils.skipCurrentTag(parser);
7747 }
7748 }
7749
7750 return intent;
7751 }
Nick Pellyccae4122012-01-09 14:12:58 -08007752
Craig Mautner21d24a22014-04-23 11:45:37 -07007753 /** @hide */
7754 public void saveToXml(XmlSerializer out) throws IOException {
7755 if (mAction != null) {
7756 out.attribute(null, ATTR_ACTION, mAction);
7757 }
7758 if (mData != null) {
7759 out.attribute(null, ATTR_DATA, mData.toString());
7760 }
7761 if (mType != null) {
7762 out.attribute(null, ATTR_TYPE, mType);
7763 }
7764 if (mComponent != null) {
7765 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7766 }
7767 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7768
7769 if (mCategories != null) {
7770 out.startTag(null, TAG_CATEGORIES);
7771 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7772 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7773 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007774 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007775 }
7776 }
7777
7778 /** @hide */
7779 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7780 XmlPullParserException {
7781 Intent intent = new Intent();
7782 final int outerDepth = in.getDepth();
7783
7784 int attrCount = in.getAttributeCount();
7785 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7786 final String attrName = in.getAttributeName(attrNdx);
7787 final String attrValue = in.getAttributeValue(attrNdx);
7788 if (ATTR_ACTION.equals(attrName)) {
7789 intent.setAction(attrValue);
7790 } else if (ATTR_DATA.equals(attrName)) {
7791 intent.setData(Uri.parse(attrValue));
7792 } else if (ATTR_TYPE.equals(attrName)) {
7793 intent.setType(attrValue);
7794 } else if (ATTR_COMPONENT.equals(attrName)) {
7795 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7796 } else if (ATTR_FLAGS.equals(attrName)) {
7797 intent.setFlags(Integer.valueOf(attrValue, 16));
7798 } else {
7799 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7800 }
7801 }
7802
7803 int event;
7804 String name;
7805 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7806 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7807 if (event == XmlPullParser.START_TAG) {
7808 name = in.getName();
7809 if (TAG_CATEGORIES.equals(name)) {
7810 attrCount = in.getAttributeCount();
7811 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7812 intent.addCategory(in.getAttributeValue(attrNdx));
7813 }
7814 } else {
7815 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7816 XmlUtils.skipCurrentTag(in);
7817 }
7818 }
7819 }
7820
7821 return intent;
7822 }
7823
Nick Pellyccae4122012-01-09 14:12:58 -08007824 /**
7825 * Normalize a MIME data type.
7826 *
7827 * <p>A normalized MIME type has white-space trimmed,
7828 * content-type parameters removed, and is lower-case.
7829 * This aligns the type with Android best practices for
7830 * intent filtering.
7831 *
7832 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7833 * "text/x-vCard" becomes "text/x-vcard".
7834 *
7835 * <p>All MIME types received from outside Android (such as user input,
7836 * or external sources like Bluetooth, NFC, or the Internet) should
7837 * be normalized before they are used to create an Intent.
7838 *
7839 * @param type MIME data type to normalize
7840 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007841 * @see #setType
7842 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007843 */
7844 public static String normalizeMimeType(String type) {
7845 if (type == null) {
7846 return null;
7847 }
7848
Elliott Hughescb64d432013-08-02 10:00:44 -07007849 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007850
7851 final int semicolonIndex = type.indexOf(';');
7852 if (semicolonIndex != -1) {
7853 type = type.substring(0, semicolonIndex);
7854 }
7855 return type;
7856 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007857
7858 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007859 * Prepare this {@link Intent} to leave an app process.
7860 *
7861 * @hide
7862 */
7863 public void prepareToLeaveProcess() {
7864 setAllowFds(false);
7865
7866 if (mSelector != null) {
7867 mSelector.prepareToLeaveProcess();
7868 }
7869 if (mClipData != null) {
7870 mClipData.prepareToLeaveProcess();
7871 }
7872
7873 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7874 // There are several ACTION_MEDIA_* broadcasts that send file://
7875 // Uris, so only check common actions.
7876 if (ACTION_VIEW.equals(mAction) ||
7877 ACTION_EDIT.equals(mAction) ||
7878 ACTION_ATTACH_DATA.equals(mAction)) {
7879 mData.checkFileUriExposed("Intent.getData()");
7880 }
7881 }
7882 }
7883
7884 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007885 * @hide
7886 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007887 public void prepareToEnterProcess() {
7888 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00007889 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
7890 fixUris(mContentUserHint);
7891 mContentUserHint = UserHandle.USER_CURRENT;
7892 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007893 }
7894 }
7895
7896 /**
7897 * @hide
7898 */
7899 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007900 Uri data = getData();
7901 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007902 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007903 }
7904 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007905 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007906 }
7907 String action = getAction();
7908 if (ACTION_SEND.equals(action)) {
7909 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7910 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007911 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007912 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007913 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007914 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7915 if (streams != null) {
7916 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7917 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007918 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007919 }
7920 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7921 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007922 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7923 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7924 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7925 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7926 if (output != null) {
7927 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7928 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007929 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007930 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007931
7932 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007933 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007934 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7935 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007936 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007937 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007938 * @hide
7939 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007940 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007941 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007942 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007943
7944 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007945 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007946
7947 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007948 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007949 // Inspect contained intents to see if we need to migrate extras. We
7950 // don't promote ClipData to the parent, since ChooserActivity will
7951 // already start the picked item as the caller, and we can't combine
7952 // the flags in a safe way.
7953
7954 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07007955 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007956 final Intent intent = getParcelableExtra(EXTRA_INTENT);
7957 if (intent != null) {
7958 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07007959 }
7960 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007961 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007962 try {
7963 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
7964 if (intents != null) {
7965 for (int i = 0; i < intents.length; i++) {
7966 final Intent intent = (Intent) intents[i];
7967 if (intent != null) {
7968 migrated |= intent.migrateExtraStreamToClipData();
7969 }
7970 }
7971 }
7972 } catch (ClassCastException e) {
7973 }
7974 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007975
7976 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007977 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007978 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7979 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7980 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7981 if (stream != null || text != null || htmlText != null) {
7982 final ClipData clipData = new ClipData(
7983 null, new String[] { getType() },
7984 new ClipData.Item(text, htmlText, null, stream));
7985 setClipData(clipData);
7986 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007987 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007988 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007989 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007990 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007991
7992 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007993 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007994 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7995 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7996 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7997 int num = -1;
7998 if (streams != null) {
7999 num = streams.size();
8000 }
8001 if (texts != null) {
8002 if (num >= 0 && num != texts.size()) {
8003 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008004 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008005 }
8006 num = texts.size();
8007 }
8008 if (htmlTexts != null) {
8009 if (num >= 0 && num != htmlTexts.size()) {
8010 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008011 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008012 }
8013 num = htmlTexts.size();
8014 }
8015 if (num > 0) {
8016 final ClipData clipData = new ClipData(
8017 null, new String[] { getType() },
8018 makeClipItem(streams, texts, htmlTexts, 0));
8019
8020 for (int i = 1; i < num; i++) {
8021 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
8022 }
8023
8024 setClipData(clipData);
8025 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008026 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008027 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008028 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008029 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008030 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8031 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8032 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8033 final Uri output;
8034 try {
8035 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8036 } catch (ClassCastException e) {
8037 return false;
8038 }
8039 if (output != null) {
8040 setClipData(ClipData.newRawUri("", output));
8041 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
8042 return true;
8043 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008044 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008045
8046 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008047 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07008048
8049 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
8050 ArrayList<String> htmlTexts, int which) {
8051 Uri uri = streams != null ? streams.get(which) : null;
8052 CharSequence text = texts != null ? texts.get(which) : null;
8053 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
8054 return new ClipData.Item(text, htmlText, null, uri);
8055 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07008056
8057 /** @hide */
8058 public boolean isDocument() {
8059 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
8060 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008061}