blob: 25be96afe59bf883b15d1c39161b17c35bcfcbf7 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Adam Powell2ed547e2015-04-29 18:45:04 -070020import android.os.ResultReceiver;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010021import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070022import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070023
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import org.xmlpull.v1.XmlPullParser;
25import org.xmlpull.v1.XmlPullParserException;
26
Tor Norbye7b9c9122013-05-30 16:48:33 -070027import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070028import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070030import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070031import android.annotation.SdkConstant.SdkConstantType;
32import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070033
Nicolas Prevotd85fc722014-04-16 19:52:08 +010034import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070035
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import android.content.pm.PackageManager;
37import android.content.pm.ResolveInfo;
38import android.content.res.Resources;
39import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080040import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070041import android.net.Uri;
42import android.os.Bundle;
43import android.os.IBinder;
44import android.os.Parcel;
45import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000046import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070047import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010048import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070049import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.DocumentsProvider;
51import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070052import android.util.AttributeSet;
53import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080054
55import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070056
Craig Mautner21d24a22014-04-23 11:45:37 -070057import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070058
59import java.io.IOException;
60import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070061import java.lang.annotation.Retention;
62import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070063import java.net.URISyntaxException;
64import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070065import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080066import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070067import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070068import java.util.Set;
69
70/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
118 * VIEW action does what what is considered the most reasonable thing for
119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
189 * These strings use java style scoping, to ensure they are unique -- for
190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
342 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
361 * <p>This filter describes the ability return to the caller a note selected by
362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700541 * <li> {@link #ACTION_UID_REMOVED}
542 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700543 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700544 * <li> {@link #ACTION_POWER_DISCONNECTED}
545 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700546 * </ul>
547 *
548 * <h3>Standard Categories</h3>
549 *
550 * <p>These are the current standard categories that can be used to further
551 * clarify an Intent via {@link #addCategory}.
552 *
553 * <ul>
554 * <li> {@link #CATEGORY_DEFAULT}
555 * <li> {@link #CATEGORY_BROWSABLE}
556 * <li> {@link #CATEGORY_TAB}
557 * <li> {@link #CATEGORY_ALTERNATIVE}
558 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
559 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800560 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700561 * <li> {@link #CATEGORY_HOME}
562 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400564 * <li> {@link #CATEGORY_CAR_DOCK}
565 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500566 * <li> {@link #CATEGORY_LE_DESK_DOCK}
567 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200568 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700569 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * </ul>
571 *
572 * <h3>Standard Extra Data</h3>
573 *
574 * <p>These are the current standard fields that can be used as extra data via
575 * {@link #putExtra}.
576 *
577 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800578 * <li> {@link #EXTRA_ALARM_COUNT}
579 * <li> {@link #EXTRA_BCC}
580 * <li> {@link #EXTRA_CC}
581 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
582 * <li> {@link #EXTRA_DATA_REMOVED}
583 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500584 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
585 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_DOCK_STATE_CAR}
587 * <li> {@link #EXTRA_DOCK_STATE_DESK}
588 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
589 * <li> {@link #EXTRA_DONT_KILL_APP}
590 * <li> {@link #EXTRA_EMAIL}
591 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700592 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700594 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700596 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
598 * <li> {@link #EXTRA_REPLACING}
599 * <li> {@link #EXTRA_SHORTCUT_ICON}
600 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
601 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700602 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800603 * <li> {@link #EXTRA_SHORTCUT_NAME}
604 * <li> {@link #EXTRA_SUBJECT}
605 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800607 * <li> {@link #EXTRA_TITLE}
608 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700609 * </ul>
610 *
611 * <h3>Flags</h3>
612 *
613 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800614 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
615 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800617public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700618 private static final String ATTR_ACTION = "action";
619 private static final String TAG_CATEGORIES = "categories";
620 private static final String ATTR_CATEGORY = "category";
621 private static final String TAG_EXTRA = "extra";
622 private static final String ATTR_TYPE = "type";
623 private static final String ATTR_COMPONENT = "component";
624 private static final String ATTR_DATA = "data";
625 private static final String ATTR_FLAGS = "flags";
626
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 // ---------------------------------------------------------------------
628 // ---------------------------------------------------------------------
629 // Standard intent activity actions (see action variable).
630
631 /**
632 * Activity Action: Start as a main entry point, does not expect to
633 * receive data.
634 * <p>Input: nothing
635 * <p>Output: nothing
636 */
637 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
638 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800639
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700640 /**
641 * Activity Action: Display the data to the user. This is the most common
642 * action performed on data -- it is the generic action you can use on
643 * a piece of data to get the most reasonable thing to occur. For example,
644 * when used on a contacts entry it will view the entry; when used on a
645 * mailto: URI it will bring up a compose window filled with the information
646 * supplied by the URI; when used with a tel: URI it will invoke the
647 * dialer.
648 * <p>Input: {@link #getData} is URI from which to retrieve data.
649 * <p>Output: nothing.
650 */
651 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
652 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800653
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700654 /**
655 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
656 * performed on a piece of data.
657 */
658 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * Used to indicate that some piece of data should be attached to some other
662 * place. For example, image data could be attached to a contact. It is up
663 * to the recipient to decide where the data should be attached; the intent
664 * does not specify the ultimate destination.
665 * <p>Input: {@link #getData} is URI of data to be attached.
666 * <p>Output: nothing.
667 */
668 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
669 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700671 /**
672 * Activity Action: Provide explicit editable access to the given data.
673 * <p>Input: {@link #getData} is URI of data to be edited.
674 * <p>Output: nothing.
675 */
676 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
677 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800678
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 /**
680 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
681 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
682 * The extras can contain type specific data to pass through to the editing/creating
683 * activity.
684 * <p>Output: The URI of the item that was picked. This must be a content:
685 * URI so that any receiver can access it.
686 */
687 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
688 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800689
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700690 /**
691 * Activity Action: Pick an item from the data, returning what was selected.
692 * <p>Input: {@link #getData} is URI containing a directory of data
693 * (vnd.android.cursor.dir/*) from which to pick an item.
694 * <p>Output: The URI of the item that was picked.
695 */
696 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
697 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800698
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700699 /**
700 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800701 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700702 * <p>Output: An Intent representing the shortcut. The intent must contain three
703 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
704 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800705 * (value: ShortcutIconResource).</p>
706 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700707 * @see #EXTRA_SHORTCUT_INTENT
708 * @see #EXTRA_SHORTCUT_NAME
709 * @see #EXTRA_SHORTCUT_ICON
710 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
711 * @see android.content.Intent.ShortcutIconResource
712 */
713 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
714 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
715
716 /**
717 * The name of the extra used to define the Intent of a shortcut.
718 *
719 * @see #ACTION_CREATE_SHORTCUT
720 */
721 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
722 /**
723 * The name of the extra used to define the name of a shortcut.
724 *
725 * @see #ACTION_CREATE_SHORTCUT
726 */
727 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
728 /**
729 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
730 *
731 * @see #ACTION_CREATE_SHORTCUT
732 */
733 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
734 /**
735 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
736 *
737 * @see #ACTION_CREATE_SHORTCUT
738 * @see android.content.Intent.ShortcutIconResource
739 */
740 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
741 "android.intent.extra.shortcut.ICON_RESOURCE";
742
743 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800744 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700745 *
746 * @see Intent#ACTION_CREATE_SHORTCUT
747 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800748 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
749 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700750 */
751 public static class ShortcutIconResource implements Parcelable {
752 /**
753 * The package name of the application containing the icon.
754 */
755 public String packageName;
756
757 /**
758 * The resource name of the icon, including package, name and type.
759 */
760 public String resourceName;
761
762 /**
763 * Creates a new ShortcutIconResource for the specified context and resource
764 * identifier.
765 *
766 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700767 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700768 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700769 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700770 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700771 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700772 ShortcutIconResource icon = new ShortcutIconResource();
773 icon.packageName = context.getPackageName();
774 icon.resourceName = context.getResources().getResourceName(resourceId);
775 return icon;
776 }
777
778 /**
779 * Used to read a ShortcutIconResource from a Parcel.
780 */
781 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
782 new Parcelable.Creator<ShortcutIconResource>() {
783
784 public ShortcutIconResource createFromParcel(Parcel source) {
785 ShortcutIconResource icon = new ShortcutIconResource();
786 icon.packageName = source.readString();
787 icon.resourceName = source.readString();
788 return icon;
789 }
790
791 public ShortcutIconResource[] newArray(int size) {
792 return new ShortcutIconResource[size];
793 }
794 };
795
796 /**
797 * No special parcel contents.
798 */
799 public int describeContents() {
800 return 0;
801 }
802
803 public void writeToParcel(Parcel dest, int flags) {
804 dest.writeString(packageName);
805 dest.writeString(resourceName);
806 }
807
808 @Override
809 public String toString() {
810 return resourceName;
811 }
812 }
813
814 /**
815 * Activity Action: Display an activity chooser, allowing the user to pick
816 * what they want to before proceeding. This can be used as an alternative
817 * to the standard activity picker that is displayed by the system when
818 * you try to start an activity with multiple possible matches, with these
819 * differences in behavior:
820 * <ul>
821 * <li>You can specify the title that will appear in the activity chooser.
822 * <li>The user does not have the option to make one of the matching
823 * activities a preferred activity, and all possible activities will
824 * always be shown even if one of them is currently marked as the
825 * preferred activity.
826 * </ul>
827 * <p>
828 * This action should be used when the user will naturally expect to
829 * select an activity in order to proceed. An example if when not to use
830 * it is when the user clicks on a "mailto:" link. They would naturally
831 * expect to go directly to their mail app, so startActivity() should be
832 * called directly: it will
833 * either launch the current preferred app, or put up a dialog allowing the
834 * user to pick an app to use and optionally marking that as preferred.
835 * <p>
836 * In contrast, if the user is selecting a menu item to send a picture
837 * they are viewing to someone else, there are many different things they
838 * may want to do at this point: send it through e-mail, upload it to a
839 * web service, etc. In this case the CHOOSER action should be used, to
840 * always present to the user a list of the things they can do, with a
841 * nice title given by the caller such as "Send this photo with:".
842 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700843 * If you need to grant URI permissions through a chooser, you must specify
844 * the permissions to be granted on the ACTION_CHOOSER Intent
845 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
846 * {@link #setClipData} to specify the URIs to be granted as well as
847 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
848 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
849 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700850 * As a convenience, an Intent of this form can be created with the
851 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700852 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700853 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700854 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
855 * and can optionally have a {@link #EXTRA_TITLE} field containing the
856 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700857 * <p>
858 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700859 */
860 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
861 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
862
863 /**
864 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
865 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700866 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
867 * target intent, also optionally supplying a title. If the target
868 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
869 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
870 * set in the returned chooser intent, with its ClipData set appropriately:
871 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500872 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700873 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700874 * @param target The Intent that the user will be selecting an activity
875 * to perform.
876 * @param title Optional title that will be displayed in the chooser.
877 * @return Return a new Intent object that you can hand to
878 * {@link Context#startActivity(Intent) Context.startActivity()} and
879 * related methods.
880 */
881 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700882 return createChooser(target, title, null);
883 }
884
885 /**
886 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
887 *
888 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
889 * target intent, also optionally supplying a title. If the target
890 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
891 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
892 * set in the returned chooser intent, with its ClipData set appropriately:
893 * either a direct reflection of {@link #getClipData()} if that is non-null,
894 * or a new ClipData built from {@link #getData()}.</p>
895 *
896 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
897 * when the user makes a choice. This can be useful if the calling application wants
898 * to remember the last chosen target and surface it as a more prominent or one-touch
899 * affordance elsewhere in the UI for next time.</p>
900 *
901 * @param target The Intent that the user will be selecting an activity
902 * to perform.
903 * @param title Optional title that will be displayed in the chooser.
904 * @param sender Optional IntentSender to be called when a choice is made.
905 * @return Return a new Intent object that you can hand to
906 * {@link Context#startActivity(Intent) Context.startActivity()} and
907 * related methods.
908 */
909 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 Intent intent = new Intent(ACTION_CHOOSER);
911 intent.putExtra(EXTRA_INTENT, target);
912 if (title != null) {
913 intent.putExtra(EXTRA_TITLE, title);
914 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700915
Adam Powell0b3c1122014-10-09 12:50:14 -0700916 if (sender != null) {
917 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
918 }
919
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700920 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700921 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
922 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
923 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700924 if (permFlags != 0) {
925 ClipData targetClipData = target.getClipData();
926 if (targetClipData == null && target.getData() != null) {
927 ClipData.Item item = new ClipData.Item(target.getData());
928 String[] mimeTypes;
929 if (target.getType() != null) {
930 mimeTypes = new String[] { target.getType() };
931 } else {
932 mimeTypes = new String[] { };
933 }
934 targetClipData = new ClipData(null, mimeTypes, item);
935 }
936 if (targetClipData != null) {
937 intent.setClipData(targetClipData);
938 intent.addFlags(permFlags);
939 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700940 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700942 return intent;
943 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700944
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700945 /**
946 * Activity Action: Allow the user to select a particular kind of data and
947 * return it. This is different than {@link #ACTION_PICK} in that here we
948 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800949 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700950 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900951 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700952 * etc.
953 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900954 * 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 -0700955 * of data, such as a person contact, you set the MIME type to the kind of
956 * data you want and launch it with {@link Context#startActivity(Intent)}.
957 * The system will then launch the best application to select that kind
958 * of data for you.
959 * <p>
960 * You may also be interested in any of a set of types of content the user
961 * can pick. For example, an e-mail application that wants to allow the
962 * user to add an attachment to an e-mail message can use this action to
963 * bring up a list of all of the types of content the user can attach.
964 * <p>
965 * In this case, you should wrap the GET_CONTENT intent with a chooser
966 * (through {@link #createChooser}), which will give the proper interface
967 * for the user to pick how to send your data and allow you to specify
968 * a prompt indicating what they are doing. You will usually specify a
969 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
970 * broad range of content types the user can select from.
971 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900972 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700973 * only pick from data that can be represented as a stream. This is
974 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
975 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800976 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900977 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800978 * is locally available on the device. For example, if this extra is set
979 * to true then an image picker should not show any pictures that are available
980 * from a remote server but not already on the local device (thus requiring
981 * they be downloaded when opened).
982 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800983 * If the caller can handle multiple returned items (the user performing
984 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
985 * to indicate this.
986 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700987 * Input: {@link #getType} is the desired MIME type to retrieve. Note
988 * that no URI is supplied in the intent, as there are no constraints on
989 * where the returned data originally comes from. You may also include the
990 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800991 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800992 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
993 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700994 * <p>
995 * Output: The URI of the item that was picked. This must be a content:
996 * URI so that any receiver can access it.
997 */
998 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
999 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1000 /**
1001 * Activity Action: Dial a number as specified by the data. This shows a
1002 * UI with the number being dialed, allowing the user to explicitly
1003 * initiate the call.
1004 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1005 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1006 * number.
1007 * <p>Output: nothing.
1008 */
1009 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1010 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1011 /**
1012 * Activity Action: Perform a call to someone specified by the data.
1013 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1014 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1015 * number.
1016 * <p>Output: nothing.
1017 *
1018 * <p>Note: there will be restrictions on which applications can initiate a
1019 * call; most applications should use the {@link #ACTION_DIAL}.
1020 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1021 * numbers. Applications can <strong>dial</strong> emergency numbers using
1022 * {@link #ACTION_DIAL}, however.
1023 */
1024 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1025 public static final String ACTION_CALL = "android.intent.action.CALL";
1026 /**
1027 * Activity Action: Perform a call to an emergency number specified by the
1028 * data.
1029 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1030 * tel: URI of an explicit phone number.
1031 * <p>Output: nothing.
1032 * @hide
1033 */
1034 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1035 /**
1036 * Activity action: Perform a call to any number (emergency or not)
1037 * specified by the data.
1038 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1039 * tel: URI of an explicit phone number.
1040 * <p>Output: nothing.
1041 * @hide
1042 */
1043 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1044 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001045 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1046 * sending this intent is a no-op.
1047 * <p>Input: No data should be specified. get*Extra may have an optional
1048 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1049 * send the activation result.
1050 * <p>Output: nothing.
1051 * @hide
1052 */
1053 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1054 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1055 "android.intent.action.SIM_ACTIVATION_REQUEST";
1056 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001057 * Activity Action: Send a message to someone specified by the data.
1058 * <p>Input: {@link #getData} is URI describing the target.
1059 * <p>Output: nothing.
1060 */
1061 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1062 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1063 /**
1064 * Activity Action: Deliver some data to someone else. Who the data is
1065 * being delivered to is not specified; it is up to the receiver of this
1066 * action to ask the user where the data should be sent.
1067 * <p>
1068 * When launching a SEND intent, you should usually wrap it in a chooser
1069 * (through {@link #createChooser}), which will give the proper interface
1070 * for the user to pick how to send your data and allow you to specify
1071 * a prompt indicating what they are doing.
1072 * <p>
1073 * Input: {@link #getType} is the MIME type of the data being sent.
1074 * get*Extra can have either a {@link #EXTRA_TEXT}
1075 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1076 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1077 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1078 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001079 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1080 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1081 * your text with HTML formatting.
1082 * <p>
1083 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1084 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1085 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1086 * content: URIs and other advanced features of {@link ClipData}. If
1087 * using this approach, you still must supply the same data through the
1088 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1089 * for compatibility with old applications. If you don't set a ClipData,
1090 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001091 * <p>
1092 * Optional standard extras, which may be interpreted by some recipients as
1093 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1094 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1095 * <p>
1096 * Output: nothing.
1097 */
1098 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1099 public static final String ACTION_SEND = "android.intent.action.SEND";
1100 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001101 * Activity Action: Deliver multiple data to someone else.
1102 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001103 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001104 * <p>
1105 * Input: {@link #getType} is the MIME type of the data being sent.
1106 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001107 * #EXTRA_STREAM} field, containing the data to be sent. If using
1108 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1109 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001110 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001111 * Multiple types are supported, and receivers should handle mixed types
1112 * whenever possible. The right way for the receiver to check them is to
1113 * use the content resolver on each URI. The intent sender should try to
1114 * put the most concrete mime type in the intent type, but it can fall
1115 * back to {@literal <type>/*} or {@literal *}/* as needed.
1116 * <p>
1117 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1118 * be image/jpg, but if you are sending image/jpg and image/png, then the
1119 * intent's type should be image/*.
1120 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001121 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1122 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1123 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1124 * content: URIs and other advanced features of {@link ClipData}. If
1125 * using this approach, you still must supply the same data through the
1126 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1127 * for compatibility with old applications. If you don't set a ClipData,
1128 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1129 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001130 * Optional standard extras, which may be interpreted by some recipients as
1131 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1132 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1133 * <p>
1134 * Output: nothing.
1135 */
1136 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1137 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1138 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001139 * Activity Action: Handle an incoming phone call.
1140 * <p>Input: nothing.
1141 * <p>Output: nothing.
1142 */
1143 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1144 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1145 /**
1146 * Activity Action: Insert an empty item into the given container.
1147 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1148 * in which to place the data.
1149 * <p>Output: URI of the new data that was created.
1150 */
1151 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1152 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1153 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001154 * Activity Action: Create a new item in the given container, initializing it
1155 * from the current contents of the clipboard.
1156 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1157 * in which to place the data.
1158 * <p>Output: URI of the new data that was created.
1159 */
1160 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1161 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1162 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001163 * Activity Action: Delete the given data from its container.
1164 * <p>Input: {@link #getData} is URI of data to be deleted.
1165 * <p>Output: nothing.
1166 */
1167 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1168 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1169 /**
1170 * Activity Action: Run the data, whatever that means.
1171 * <p>Input: ? (Note: this is currently specific to the test harness.)
1172 * <p>Output: nothing.
1173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_RUN = "android.intent.action.RUN";
1176 /**
1177 * Activity Action: Perform a data synchronization.
1178 * <p>Input: ?
1179 * <p>Output: ?
1180 */
1181 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1182 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1183 /**
1184 * Activity Action: Pick an activity given an intent, returning the class
1185 * selected.
1186 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1187 * used with {@link PackageManager#queryIntentActivities} to determine the
1188 * set of activities from which to pick.
1189 * <p>Output: Class name of the activity that was selected.
1190 */
1191 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1192 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1193 /**
1194 * Activity Action: Perform a search.
1195 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1196 * is the text to search for. If empty, simply
1197 * enter your search results Activity with the search UI activated.
1198 * <p>Output: nothing.
1199 */
1200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1201 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1202 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001203 * Activity Action: Start the platform-defined tutorial
1204 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1205 * is the text to search for. If empty, simply
1206 * enter your search results Activity with the search UI activated.
1207 * <p>Output: nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1211 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001212 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001213 * <p>
1214 * Input: {@link android.app.SearchManager#QUERY
1215 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1216 * a url starts with http or https, the site will be opened. If it is plain
1217 * text, Google search will be applied.
1218 * <p>
1219 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001220 */
1221 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1222 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001223
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001224 /**
Jim Miller07994402012-05-02 14:22:27 -07001225 * Activity Action: Perform assist action.
1226 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001227 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1228 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001229 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1230 * information.
Jim Miller07994402012-05-02 14:22:27 -07001231 * Output: nothing.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001235
1236 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001237 * Activity Action: Perform voice assist action.
1238 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001239 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1240 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001241 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001242 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001243 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001244 */
1245 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1246 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1247
1248 /**
Adam Skory7140a252013-09-11 12:04:58 +01001249 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1250 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001251 */
1252 public static final String EXTRA_ASSIST_PACKAGE
1253 = "android.intent.extra.ASSIST_PACKAGE";
1254
1255 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001256 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1257 * application package at the time the assist was invoked.
1258 */
1259 public static final String EXTRA_ASSIST_UID
1260 = "android.intent.extra.ASSIST_UID";
1261
1262 /**
Adam Skory7140a252013-09-11 12:04:58 +01001263 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1264 * information supplied by the current foreground app at the time of the assist request.
1265 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001266 */
1267 public static final String EXTRA_ASSIST_CONTEXT
1268 = "android.intent.extra.ASSIST_CONTEXT";
1269
Jim Miller07994402012-05-02 14:22:27 -07001270 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001271 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1272 * keyboard as the primary input device for assistance.
1273 */
1274 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1275 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1276
1277 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001278 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1279 * that was used to invoke the assist.
1280 */
1281 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1282 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1283
1284 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001285 * Activity Action: List all available applications
1286 * <p>Input: Nothing.
1287 * <p>Output: nothing.
1288 */
1289 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1290 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1291 /**
1292 * Activity Action: Show settings for choosing wallpaper
1293 * <p>Input: Nothing.
1294 * <p>Output: Nothing.
1295 */
1296 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1297 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1298
1299 /**
1300 * Activity Action: Show activity for reporting a bug.
1301 * <p>Input: Nothing.
1302 * <p>Output: Nothing.
1303 */
1304 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1305 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1306
1307 /**
1308 * Activity Action: Main entry point for factory tests. Only used when
1309 * the device is booting in factory test node. The implementing package
1310 * must be installed in the system image.
1311 * <p>Input: nothing
1312 * <p>Output: nothing
1313 */
1314 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1315
1316 /**
1317 * Activity Action: The user pressed the "call" button to go to the dialer
1318 * or other appropriate UI for placing a call.
1319 * <p>Input: Nothing.
1320 * <p>Output: Nothing.
1321 */
1322 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1323 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1324
1325 /**
1326 * Activity Action: Start Voice Command.
1327 * <p>Input: Nothing.
1328 * <p>Output: Nothing.
1329 */
1330 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1331 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001332
1333 /**
1334 * Activity Action: Start action associated with long pressing on the
1335 * search key.
1336 * <p>Input: Nothing.
1337 * <p>Output: Nothing.
1338 */
1339 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1340 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001341
Jacek Surazski86b6c532009-05-13 14:38:28 +02001342 /**
1343 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1344 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001345 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001346 * <p>Input: No data is specified. The bug report is passed in using
1347 * an {@link #EXTRA_BUG_REPORT} field.
1348 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001349 *
1350 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001351 */
1352 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1353 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001354
1355 /**
1356 * Activity Action: Show power usage information to the user.
1357 * <p>Input: Nothing.
1358 * <p>Output: Nothing.
1359 */
1360 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1361 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001362
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001363 /**
1364 * Activity Action: Setup wizard to launch after a platform update. This
1365 * activity should have a string meta-data field associated with it,
1366 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1367 * the platform for setup. The activity will be launched only if
1368 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1369 * same value.
1370 * <p>Input: Nothing.
1371 * <p>Output: Nothing.
1372 * @hide
1373 */
1374 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1375 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001376
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001377 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001378 * Activity Action: Show settings for managing network data usage of a
1379 * specific application. Applications should define an activity that offers
1380 * options to control data usage.
1381 */
1382 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1383 public static final String ACTION_MANAGE_NETWORK_USAGE =
1384 "android.intent.action.MANAGE_NETWORK_USAGE";
1385
1386 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001387 * Activity Action: Launch application installer.
1388 * <p>
1389 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001390 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1391 * you can also use "package:<package-name>" to install an application for the
1392 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001393 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1394 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1395 * <p>
1396 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1397 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001398 * <p>
1399 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1400 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1401 * in order to launch the application installer.
1402 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001403 *
1404 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1405 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1406 * @see #EXTRA_RETURN_RESULT
1407 */
1408 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1409 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1410
1411 /**
1412 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1413 * package. Specifies the installer package name; this package will receive the
1414 * {@link #ACTION_APP_ERROR} intent.
1415 */
1416 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1417 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1418
1419 /**
1420 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1421 * package. Specifies that the application being installed should not be
1422 * treated as coming from an unknown source, but as coming from the app
1423 * invoking the Intent. For this to work you must start the installer with
1424 * startActivityForResult().
1425 */
1426 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1427 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1428
1429 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001430 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1431 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001432 * data field originated from.
1433 */
rich cannings706e8ba2012-08-20 13:20:14 -07001434 public static final String EXTRA_ORIGINATING_URI
1435 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001436
1437 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001438 * This extra can be used with any Intent used to launch an activity, supplying information
1439 * about who is launching that activity. This field contains a {@link android.net.Uri}
1440 * object, typically an http: or https: URI of the web site that the referral came from;
1441 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1442 * a native application that it came from.
1443 *
1444 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1445 * instead of directly retrieving the extra. It is also valid for applications to
1446 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1447 * a string, not a Uri; the field here, if supplied, will always take precedence,
1448 * however.</p>
1449 *
1450 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001451 */
1452 public static final String EXTRA_REFERRER
1453 = "android.intent.extra.REFERRER";
1454
1455 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001456 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1457 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1458 * not be created, in particular when Intent extras are supplied through the
1459 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1460 * schemes.
1461 *
1462 * @see #EXTRA_REFERRER
1463 */
1464 public static final String EXTRA_REFERRER_NAME
1465 = "android.intent.extra.REFERRER_NAME";
1466
1467 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001468 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1469 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1470 * @hide
1471 */
1472 public static final String EXTRA_ORIGINATING_UID
1473 = "android.intent.extra.ORIGINATING_UID";
1474
1475 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001476 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1477 * package. Tells the installer UI to skip the confirmation with the user
1478 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001479 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1480 * will no longer show an interstitial message about updating existing
1481 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001482 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001483 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001484 public static final String EXTRA_ALLOW_REPLACE
1485 = "android.intent.extra.ALLOW_REPLACE";
1486
1487 /**
1488 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1489 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1490 * return to the application the result code of the install/uninstall. The returned result
1491 * code will be {@link android.app.Activity#RESULT_OK} on success or
1492 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1493 */
1494 public static final String EXTRA_RETURN_RESULT
1495 = "android.intent.extra.RETURN_RESULT";
1496
1497 /**
1498 * Package manager install result code. @hide because result codes are not
1499 * yet ready to be exposed.
1500 */
1501 public static final String EXTRA_INSTALL_RESULT
1502 = "android.intent.extra.INSTALL_RESULT";
1503
1504 /**
1505 * Activity Action: Launch application uninstaller.
1506 * <p>
1507 * Input: The data must be a package: URI whose scheme specific part is
1508 * the package name of the current installed package to be uninstalled.
1509 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1510 * <p>
1511 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1512 * succeeded.
1513 */
1514 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1515 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1516
1517 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001518 * Specify whether the package should be uninstalled for all users.
1519 * @hide because these should not be part of normal application flow.
1520 */
1521 public static final String EXTRA_UNINSTALL_ALL_USERS
1522 = "android.intent.extra.UNINSTALL_ALL_USERS";
1523
1524 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001525 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1526 * describing the last run version of the platform that was setup.
1527 * @hide
1528 */
1529 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1530
Svet Ganov3695b8a2015-03-24 16:30:25 -07001531 /**
1532 * Activity action: Launch UI to manage the permissions of an app.
1533 * <p>
1534 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1535 * will be managed by the launched UI.
1536 * </p>
1537 * <p>
1538 * Output: Nothing.
1539 * </p>
1540 *
1541 * @see #EXTRA_PACKAGE_NAME
1542 *
1543 * @hide
1544 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001545 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1546 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1547 "android.intent.action.MANAGE_APP_PERMISSIONS";
1548
1549 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001550 * Activity action: Launch UI to manage permissions.
1551 * <p>
1552 * Input: Nothing.
1553 * </p>
1554 * <p>
1555 * Output: Nothing.
1556 * </p>
1557 *
1558 * @hide
1559 */
Svet Ganov321f0152015-05-16 22:51:50 -07001560 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1561 public static final String ACTION_MANAGE_PERMISSIONS =
1562 "android.intent.action.MANAGE_PERMISSIONS";
1563
1564 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001565 * Intent extra: An app package name.
1566 * <p>
1567 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001568 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001569 *
1570 * @hide
1571 */
1572 @SystemApi
1573 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1574
1575 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001576 * Broadcast action that requests current permission granted information. It will respond
1577 * to the request by sending a broadcast with action defined by
1578 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
1579 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT} with contents described below or a null upon
1580 * failure.
1581 *
1582 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted and the
1583 * number of permissions requested by that package will be calculated and included as the first
1584 * and second elements respectively of an int[] in the response as
1585 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1586 *
1587 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1588 * permissions and the total number of apps requesting runtime permissions will be the first
1589 * and second elements respectively of an int[] in the response as
1590 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1591 *
1592 * @hide
1593 */
1594 public static final String ACTION_GET_PERMISSIONS_COUNT
1595 = "android.intent.action.GET_PERMISSIONS_COUNT";
1596
1597 /**
1598 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1599 * @hide
1600 */
1601 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1602 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1603
1604 /**
1605 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcast.
1606 * @hide
1607 */
1608 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1609 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1610
1611 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001612 * Activity action: Launch UI to manage which apps have a given permission.
1613 * <p>
1614 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1615 * to which will be managed by the launched UI.
1616 * </p>
1617 * <p>
1618 * Output: Nothing.
1619 * </p>
1620 *
1621 * @see #EXTRA_PERMISSION_NAME
1622 *
1623 * @hide
1624 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001625 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1626 public static final String ACTION_MANAGE_PERMISSION_APPS =
1627 "android.intent.action.MANAGE_PERMISSION_APPS";
1628
1629 /**
1630 * Intent extra: The name of a permission.
1631 * <p>
1632 * Type: String
1633 * </p>
1634 *
1635 * @hide
1636 */
1637 @SystemApi
1638 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1639
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001640 // ---------------------------------------------------------------------
1641 // ---------------------------------------------------------------------
1642 // Standard intent broadcast actions (see action variable).
1643
1644 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001645 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1646 * <p>
1647 * For historical reasons, the name of this broadcast action refers to the power
1648 * state of the screen but it is actually sent in response to changes in the
1649 * overall interactive state of the device.
1650 * </p><p>
1651 * This broadcast is sent when the device becomes non-interactive which may have
1652 * nothing to do with the screen turning off. To determine the
1653 * actual state of the screen, use {@link android.view.Display#getState}.
1654 * </p><p>
1655 * See {@link android.os.PowerManager#isInteractive} for details.
1656 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001657 * You <em>cannot</em> receive this through components declared in
1658 * manifests, only by explicitly registering for it with
1659 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1660 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001661 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001662 * <p class="note">This is a protected intent that can only be sent
1663 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001664 */
1665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1666 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001667
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001668 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001669 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1670 * <p>
1671 * For historical reasons, the name of this broadcast action refers to the power
1672 * state of the screen but it is actually sent in response to changes in the
1673 * overall interactive state of the device.
1674 * </p><p>
1675 * This broadcast is sent when the device becomes interactive which may have
1676 * nothing to do with the screen turning on. To determine the
1677 * actual state of the screen, use {@link android.view.Display#getState}.
1678 * </p><p>
1679 * See {@link android.os.PowerManager#isInteractive} for details.
1680 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001681 * You <em>cannot</em> receive this through components declared in
1682 * manifests, only by explicitly registering for it with
1683 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1684 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001685 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001686 * <p class="note">This is a protected intent that can only be sent
1687 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001688 */
1689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1690 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001691
1692 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001693 * Broadcast Action: Sent after the system stops dreaming.
1694 *
1695 * <p class="note">This is a protected intent that can only be sent by the system.
1696 * It is only sent to registered receivers.</p>
1697 */
1698 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1699 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1700
1701 /**
1702 * Broadcast Action: Sent after the system starts dreaming.
1703 *
1704 * <p class="note">This is a protected intent that can only be sent by the system.
1705 * It is only sent to registered receivers.</p>
1706 */
1707 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1708 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1709
1710 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001711 * 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 -07001712 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001713 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001714 * <p class="note">This is a protected intent that can only be sent
1715 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001716 */
1717 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001718 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001719
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001720 /**
1721 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001722 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001723 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001724 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1725 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001726 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001727 * <p class="note">This is a protected intent that can only be sent
1728 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001729 */
1730 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1731 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1732 /**
1733 * Broadcast Action: The time was set.
1734 */
1735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1736 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1737 /**
1738 * Broadcast Action: The date has changed.
1739 */
1740 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1741 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1742 /**
1743 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1744 * <ul>
1745 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1746 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001747 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001748 * <p class="note">This is a protected intent that can only be sent
1749 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001750 */
1751 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1752 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1753 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001754 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1755 * DNS entries should be tossed.
1756 * @hide
1757 */
1758 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1759 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1760 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001761 * Alarm Changed Action: This is broadcast when the AlarmClock
1762 * application's alarm is set or unset. It is used by the
1763 * AlarmClock application and the StatusBar service.
1764 * @hide
1765 */
1766 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1767 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1768 /**
1769 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1770 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1771 * @hide
1772 */
1773 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1774 public static final String ACTION_SYNC_STATE_CHANGED
1775 = "android.intent.action.SYNC_STATE_CHANGED";
1776 /**
1777 * Broadcast Action: This is broadcast once, after the system has finished
1778 * booting. It can be used to perform application-specific initialization,
1779 * such as installing alarms. You must hold the
1780 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1781 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001782 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001783 * <p class="note">This is a protected intent that can only be sent
1784 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001785 */
1786 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1787 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1788 /**
1789 * Broadcast Action: This is broadcast when a user action should request a
1790 * temporary system dialog to dismiss. Some examples of temporary system
1791 * dialogs are the notification window-shade and the recent tasks dialog.
1792 */
1793 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1794 /**
1795 * Broadcast Action: Trigger the download and eventual installation
1796 * of a package.
1797 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001798 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001799 * <p class="note">This is a protected intent that can only be sent
1800 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001801 *
1802 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001803 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001804 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001805 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1806 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1807 /**
1808 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001809 * device. The data contains the name of the package. Note that the
1810 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001811 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001812 * <ul>
1813 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1814 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1815 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1816 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001817 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001818 * <p class="note">This is a protected intent that can only be sent
1819 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1822 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1823 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001824 * Broadcast Action: A new version of an application package has been
1825 * installed, replacing an existing version that was previously installed.
1826 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001827 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001828 * <ul>
1829 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1830 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001831 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001832 * <p class="note">This is a protected intent that can only be sent
1833 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001834 */
1835 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1836 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1837 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001838 * Broadcast Action: A new version of your application has been installed
1839 * over an existing one. This is only sent to the application that was
1840 * replaced. It does not contain any additional data; to receive it, just
1841 * use an intent filter for this action.
1842 *
1843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
1845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 * Broadcast Action: An existing application package has been removed from
1850 * the device. The data contains the name of the package. The package
1851 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001852 * <ul>
1853 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1854 * to the package.
1855 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1856 * application -- data and code -- is being removed.
1857 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1858 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1859 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001860 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001861 * <p class="note">This is a protected intent that can only be sent
1862 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1866 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001867 * Broadcast Action: An existing application package has been completely
1868 * removed from the device. The data contains the name of the package.
1869 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1870 * {@link #EXTRA_DATA_REMOVED} is true and
1871 * {@link #EXTRA_REPLACING} is false of that broadcast.
1872 *
1873 * <ul>
1874 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1875 * to the package.
1876 * </ul>
1877 *
1878 * <p class="note">This is a protected intent that can only be sent
1879 * by the system.
1880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1882 public static final String ACTION_PACKAGE_FULLY_REMOVED
1883 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1884 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001885 * Broadcast Action: An existing application package has been changed (e.g.
1886 * a component has been enabled or disabled). The data contains the name of
1887 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001888 * <ul>
1889 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001890 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001891 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001892 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1893 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001894 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001895 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001896 * <p class="note">This is a protected intent that can only be sent
1897 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001898 */
1899 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1900 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1901 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001902 * @hide
1903 * Broadcast Action: Ask system services if there is any reason to
1904 * restart the given package. The data contains the name of the
1905 * package.
1906 * <ul>
1907 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1908 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1909 * </ul>
1910 *
1911 * <p class="note">This is a protected intent that can only be sent
1912 * by the system.
1913 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08001914 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001915 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1916 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1917 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001918 * Broadcast Action: The user has restarted a package, and all of its
1919 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001920 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001921 * be removed. Note that the restarted package does <em>not</em>
1922 * receive this broadcast.
1923 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001924 * <ul>
1925 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1926 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001927 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001928 * <p class="note">This is a protected intent that can only be sent
1929 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 */
1931 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1932 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1933 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001934 * Broadcast Action: The user has cleared the data of a package. This should
1935 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001936 * its persistent data is erased and this broadcast sent.
1937 * Note that the cleared package does <em>not</em>
1938 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001939 * <ul>
1940 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1941 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001942 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001943 * <p class="note">This is a protected intent that can only be sent
1944 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001945 */
1946 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1947 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1948 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001949 * Broadcast Action: A user ID has been removed from the system. The user
1950 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001951 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001952 * <p class="note">This is a protected intent that can only be sent
1953 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 */
1955 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1956 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001957
1958 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001959 * Broadcast Action: Sent to the installer package of an application
1960 * when that application is first launched (that is the first time it
1961 * is moved out of the stopped state). The data contains the name of the package.
1962 *
1963 * <p class="note">This is a protected intent that can only be sent
1964 * by the system.
1965 */
1966 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1967 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1968
1969 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001970 * Broadcast Action: Sent to the system package verifier when a package
1971 * needs to be verified. The data contains the package URI.
1972 * <p class="note">
1973 * This is a protected intent that can only be sent by the system.
1974 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001975 */
1976 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1977 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1978
1979 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001980 * Broadcast Action: Sent to the system package verifier when a package is
1981 * verified. The data contains the package URI.
1982 * <p class="note">
1983 * This is a protected intent that can only be sent by the system.
1984 */
1985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1986 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1987
1988 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08001989 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
1990 * needs to be verified. The data contains the filter data hosts to be verified against.
1991 * <p class="note">
1992 * This is a protected intent that can only be sent by the system.
1993 * </p>
1994 *
1995 * @hide
1996 */
1997 @SystemApi
1998 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1999 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2000
2001 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002002 * Broadcast Action: Resources for a set of packages (which were
2003 * previously unavailable) are currently
2004 * available since the media on which they exist is available.
2005 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2006 * list of packages whose availability changed.
2007 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2008 * list of uids of packages whose availability changed.
2009 * Note that the
2010 * packages in this list do <em>not</em> receive this broadcast.
2011 * The specified set of packages are now available on the system.
2012 * <p>Includes the following extras:
2013 * <ul>
2014 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2015 * whose resources(were previously unavailable) are currently available.
2016 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2017 * packages whose resources(were previously unavailable)
2018 * are currently available.
2019 * </ul>
2020 *
2021 * <p class="note">This is a protected intent that can only be sent
2022 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002025 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2026 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002027
2028 /**
2029 * Broadcast Action: Resources for a set of packages are currently
2030 * unavailable since the media on which they exist is unavailable.
2031 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2032 * list of packages whose availability changed.
2033 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2034 * list of uids of packages whose availability changed.
2035 * The specified set of packages can no longer be
2036 * launched and are practically unavailable on the system.
2037 * <p>Inclues the following extras:
2038 * <ul>
2039 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2040 * whose resources are no longer available.
2041 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2042 * whose resources are no longer available.
2043 * </ul>
2044 *
2045 * <p class="note">This is a protected intent that can only be sent
2046 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002047 */
2048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002049 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002050 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002051
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052 /**
2053 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002054 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002055 * This should <em>only</em> be used to determine when the wallpaper
2056 * has changed to show the new wallpaper to the user. You should certainly
2057 * never, in response to this, change the wallpaper or other attributes of
2058 * it such as the suggested size. That would be crazy, right? You'd cause
2059 * all kinds of loops, especially if other apps are doing similar things,
2060 * right? Of course. So please don't do this.
2061 *
2062 * @deprecated Modern applications should use
2063 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2064 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2065 * shown behind their UI, rather than watching for this broadcast and
2066 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002067 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002068 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002069 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2070 /**
2071 * Broadcast Action: The current device {@link android.content.res.Configuration}
2072 * (orientation, locale, etc) has changed. When such a change happens, the
2073 * UIs (view hierarchy) will need to be rebuilt based on this new
2074 * information; for the most part, applications don't need to worry about
2075 * this, because the system will take care of stopping and restarting the
2076 * application to make sure it sees the new changes. Some system code that
2077 * can not be restarted will need to watch for this action and handle it
2078 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002079 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002080 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002081 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002082 * in manifests, only by explicitly registering for it with
2083 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2084 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002085 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002086 * <p class="note">This is a protected intent that can only be sent
2087 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002088 *
2089 * @see android.content.res.Configuration
2090 */
2091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2093 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002094 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002095 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002096 * <p class="note">This is a protected intent that can only be sent
2097 * by the system.
2098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2101 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002102 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2103 * charging state, level, and other information about the battery.
2104 * See {@link android.os.BatteryManager} for documentation on the
2105 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002106 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002107 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002108 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002109 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002110 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002111 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2112 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2113 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2114 * broadcasts that are sent and can be received through manifest
2115 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002116 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002117 * <p class="note">This is a protected intent that can only be sent
2118 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002119 */
2120 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2121 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2122 /**
2123 * Broadcast Action: Indicates low battery condition on the device.
2124 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002125 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002126 * <p class="note">This is a protected intent that can only be sent
2127 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2131 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002132 * Broadcast Action: Indicates the battery is now okay after being low.
2133 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2134 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002135 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002136 * <p class="note">This is a protected intent that can only be sent
2137 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002138 */
2139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2140 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2141 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002142 * Broadcast Action: External power has been connected to the device.
2143 * This is intended for applications that wish to register specifically to this notification.
2144 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2145 * stay active to receive this notification. This action can be used to implement actions
2146 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002147 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002148 * <p class="note">This is a protected intent that can only be sent
2149 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002150 */
2151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002152 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002153 /**
2154 * Broadcast Action: External power has been removed from the device.
2155 * This is intended for applications that wish to register specifically to this notification.
2156 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2157 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002158 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002159 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002160 * <p class="note">This is a protected intent that can only be sent
2161 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002162 */
2163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002164 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002165 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002166 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002167 * Broadcast Action: Device is shutting down.
2168 * This is broadcast when the device is being shut down (completely turned
2169 * off, not sleeping). Once the broadcast is complete, the final shutdown
2170 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002171 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002172 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002173 * <p class="note">This is a protected intent that can only be sent
2174 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002175 * <p>May include the following extras:
2176 * <ul>
2177 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2178 * shutdown is only for userspace processes. If not set, assumed to be false.
2179 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002180 */
2181 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002182 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002183 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002184 * Activity Action: Start this activity to request system shutdown.
2185 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
2186 * to request confirmation from the user before shutting down.
2187 *
2188 * <p class="note">This is a protected intent that can only be sent
2189 * by the system.
2190 *
2191 * {@hide}
2192 */
2193 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2194 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002195 * Broadcast Action: A sticky broadcast that indicates low memory
2196 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002197 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002198 * <p class="note">This is a protected intent that can only be sent
2199 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002200 */
2201 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2202 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2203 /**
2204 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002205 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002206 * <p class="note">This is a protected intent that can only be sent
2207 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002208 */
2209 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2210 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2211 /**
Jake Hambybb371632010-08-23 18:16:48 -07002212 * Broadcast Action: A sticky broadcast that indicates a memory full
2213 * condition on the device. This is intended for activities that want
2214 * to be able to fill the data partition completely, leaving only
2215 * enough free space to prevent system-wide SQLite failures.
2216 *
2217 * <p class="note">This is a protected intent that can only be sent
2218 * by the system.
2219 *
2220 * {@hide}
2221 */
2222 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2223 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2224 /**
2225 * Broadcast Action: Indicates memory full condition on the device
2226 * no longer exists.
2227 *
2228 * <p class="note">This is a protected intent that can only be sent
2229 * by the system.
2230 *
2231 * {@hide}
2232 */
2233 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2234 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2235 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002236 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2237 * and package management should be started.
2238 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2239 * notification.
2240 */
2241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2242 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2243 /**
2244 * Broadcast Action: The device has entered USB Mass Storage mode.
2245 * This is used mainly for the USB Settings panel.
2246 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2247 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002248 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002249 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002250 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002251 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2252
2253 /**
2254 * Broadcast Action: The device has exited USB Mass Storage mode.
2255 * This is used mainly for the USB Settings panel.
2256 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2257 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002258 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002259 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002260 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002261 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2262
2263 /**
2264 * Broadcast Action: External media has been removed.
2265 * The path to the mount point for the removed media is contained in the Intent.mData field.
2266 */
2267 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2268 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2269
2270 /**
2271 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002272 * 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 -07002273 */
2274 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2275 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2276
2277 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002278 * Broadcast Action: External media is present, and being disk-checked
2279 * 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 -08002280 */
2281 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2282 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2283
2284 /**
2285 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2286 * 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 -08002287 */
2288 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2289 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2290
2291 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002292 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002293 * 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 -07002294 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2295 * media was mounted read only.
2296 */
2297 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2298 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2299
2300 /**
2301 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002302 * 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 -07002303 */
2304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2305 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2306
2307 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002308 * Broadcast Action: External media is no longer being shared via USB mass storage.
2309 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2310 *
2311 * @hide
2312 */
2313 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2314
2315 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002316 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2317 * The path to the mount point for the removed media is contained in the Intent.mData field.
2318 */
2319 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2320 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2321
2322 /**
2323 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002324 * 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 -07002325 */
2326 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2327 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2328
2329 /**
2330 * Broadcast Action: User has expressed the desire to remove the external storage media.
2331 * Applications should close all files they have open within the mount point when they receive this intent.
2332 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2335 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2336
2337 /**
2338 * Broadcast Action: The media scanner has started scanning a directory.
2339 * The path to the directory being scanned is contained in the Intent.mData field.
2340 */
2341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2342 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2343
2344 /**
2345 * Broadcast Action: The media scanner has finished scanning a directory.
2346 * The path to the scanned directory is contained in the Intent.mData field.
2347 */
2348 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2349 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2350
2351 /**
2352 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2353 * The path to the file is contained in the Intent.mData field.
2354 */
2355 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2356 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2357
2358 /**
2359 * Broadcast Action: The "Media Button" was pressed. Includes a single
2360 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2361 * caused the broadcast.
2362 */
2363 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2364 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2365
2366 /**
2367 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2368 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2369 * caused the broadcast.
2370 */
2371 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2372 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2373
2374 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2375 // location; they are not general-purpose actions.
2376
2377 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002378 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002379 */
2380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2381 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2382 "android.intent.action.GTALK_CONNECTED";
2383
2384 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002385 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002386 */
2387 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2388 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2389 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002390
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002391 /**
2392 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002393 */
2394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2395 public static final String ACTION_INPUT_METHOD_CHANGED =
2396 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002397
2398 /**
2399 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2400 * more radios have been turned off or on. The intent will have the following extra value:</p>
2401 * <ul>
2402 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2403 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2404 * turned off</li>
2405 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002406 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002407 * <p class="note">This is a protected intent that can only be sent
2408 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002409 */
2410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2411 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2412
2413 /**
2414 * Broadcast Action: Some content providers have parts of their namespace
2415 * where they publish new events or items that the user may be especially
2416 * interested in. For these things, they may broadcast this action when the
2417 * set of interesting items change.
2418 *
2419 * For example, GmailProvider sends this notification when the set of unread
2420 * mail in the inbox changes.
2421 *
2422 * <p>The data of the intent identifies which part of which provider
2423 * changed. When queried through the content resolver, the data URI will
2424 * return the data set in question.
2425 *
2426 * <p>The intent will have the following extra values:
2427 * <ul>
2428 * <li><em>count</em> - The number of items in the data set. This is the
2429 * same as the number of items in the cursor returned by querying the
2430 * data URI. </li>
2431 * </ul>
2432 *
2433 * This intent will be sent at boot (if the count is non-zero) and when the
2434 * data set changes. It is possible for the data set to change without the
2435 * count changing (for example, if a new unread message arrives in the same
2436 * sync operation in which a message is archived). The phone should still
2437 * ring/vibrate/etc as normal in this case.
2438 */
2439 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2440 public static final String ACTION_PROVIDER_CHANGED =
2441 "android.intent.action.PROVIDER_CHANGED";
2442
2443 /**
2444 * Broadcast Action: Wired Headset plugged in or unplugged.
2445 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002446 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2447 * and documentation.
2448 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002449 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002450 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002451 */
2452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002453 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002454
2455 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002456 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2457 * <ul>
2458 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2459 * </ul>
2460 *
2461 * <p class="note">This is a protected intent that can only be sent
2462 * by the system.
2463 *
2464 * @hide
2465 */
2466 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2467 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2468 = "android.intent.action.ADVANCED_SETTINGS";
2469
2470 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002471 * Broadcast Action: Sent after application restrictions are changed.
2472 *
2473 * <p class="note">This is a protected intent that can only be sent
2474 * by the system.</p>
2475 */
2476 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2477 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2478 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2479
2480 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002481 * Broadcast Action: An outgoing call is about to be placed.
2482 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002483 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002484 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002485 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002486 * the phone number originally intended to be dialed.</li>
2487 * </ul>
2488 * <p>Once the broadcast is finished, the resultData is used as the actual
2489 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002490 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002491 * outgoing call in turn: for example, a parental control application
2492 * might verify that the user is authorized to place the call at that
2493 * time, then a number-rewriting application might add an area code if
2494 * one was not specified.</p>
2495 * <p>For consistency, any receiver whose purpose is to prohibit phone
2496 * calls should have a priority of 0, to ensure it will see the final
2497 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002498 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002499 * should have a positive priority.
2500 * Negative priorities are reserved for the system for this broadcast;
2501 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002502 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2503 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002504 * <p>Emergency calls cannot be intercepted using this mechanism, and
2505 * other calls cannot be modified to call emergency numbers using this
2506 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002507 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2508 * call to use their own service instead. Those apps should first prevent
2509 * the call from being placed by setting resultData to <code>null</code>
2510 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002511 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002512 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2513 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002514 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002515 * <p class="note">This is a protected intent that can only be sent
2516 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002517 */
2518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2519 public static final String ACTION_NEW_OUTGOING_CALL =
2520 "android.intent.action.NEW_OUTGOING_CALL";
2521
2522 /**
2523 * Broadcast Action: Have the device reboot. This is only for use by
2524 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002525 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002526 * <p class="note">This is a protected intent that can only be sent
2527 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002528 */
2529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2530 public static final String ACTION_REBOOT =
2531 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002532
Wei Huang97ecc9c2009-05-11 17:44:20 -07002533 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002534 * Broadcast Action: A sticky broadcast for changes in the physical
2535 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002536 *
2537 * <p>The intent will have the following extra values:
2538 * <ul>
2539 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002540 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002541 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002542 * <p>This is intended for monitoring the current physical dock state.
2543 * See {@link android.app.UiModeManager} for the normal API dealing with
2544 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002545 */
2546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2547 public static final String ACTION_DOCK_EVENT =
2548 "android.intent.action.DOCK_EVENT";
2549
2550 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002551 * Broadcast Action: A broadcast when idle maintenance can be started.
2552 * This means that the user is not interacting with the device and is
2553 * not expected to do so soon. Typical use of the idle maintenance is
2554 * to perform somehow expensive tasks that can be postponed at a moment
2555 * when they will not degrade user experience.
2556 * <p>
2557 * <p class="note">In order to keep the device responsive in case of an
2558 * unexpected user interaction, implementations of a maintenance task
2559 * should be interruptible. In such a scenario a broadcast with action
2560 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2561 * should not do the maintenance work in
2562 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2563 * maintenance service by {@link Context#startService(Intent)}. Also
2564 * you should hold a wake lock while your maintenance service is running
2565 * to prevent the device going to sleep.
2566 * </p>
2567 * <p>
2568 * <p class="note">This is a protected intent that can only be sent by
2569 * the system.
2570 * </p>
2571 *
2572 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002573 *
2574 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002575 */
2576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2577 public static final String ACTION_IDLE_MAINTENANCE_START =
2578 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2579
2580 /**
2581 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2582 * This means that the user was not interacting with the device as a result
2583 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2584 * was sent and now the user started interacting with the device. Typical
2585 * use of the idle maintenance is to perform somehow expensive tasks that
2586 * can be postponed at a moment when they will not degrade user experience.
2587 * <p>
2588 * <p class="note">In order to keep the device responsive in case of an
2589 * unexpected user interaction, implementations of a maintenance task
2590 * should be interruptible. Hence, on receiving a broadcast with this
2591 * action, the maintenance task should be interrupted as soon as possible.
2592 * In other words, you should not do the maintenance work in
2593 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2594 * maintenance service that was started on receiving of
2595 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2596 * lock you acquired when your maintenance service started.
2597 * </p>
2598 * <p class="note">This is a protected intent that can only be sent
2599 * by the system.
2600 *
2601 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002602 *
2603 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002604 */
2605 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2606 public static final String ACTION_IDLE_MAINTENANCE_END =
2607 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2608
2609 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002610 * Broadcast Action: a remote intent is to be broadcasted.
2611 *
2612 * A remote intent is used for remote RPC between devices. The remote intent
2613 * is serialized and sent from one device to another device. The receiving
2614 * device parses the remote intent and broadcasts it. Note that anyone can
2615 * broadcast a remote intent. However, if the intent receiver of the remote intent
2616 * does not trust intent broadcasts from arbitrary intent senders, it should require
2617 * the sender to hold certain permissions so only trusted sender's broadcast will be
2618 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002619 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002620 */
2621 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002622 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002623
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002624 /**
2625 * Broadcast Action: hook for permforming cleanup after a system update.
2626 *
2627 * The broadcast is sent when the system is booting, before the
2628 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2629 * image. A receiver for this should do its work and then disable itself
2630 * so that it does not get run again at the next boot.
2631 * @hide
2632 */
2633 public static final String ACTION_PRE_BOOT_COMPLETED =
2634 "android.intent.action.PRE_BOOT_COMPLETED";
2635
Amith Yamasani13593602012-03-22 16:16:17 -07002636 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002637 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002638 * on restricted users. The broadcast intent contains an extra
2639 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2640 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2641 * String[] depending on the restriction type.<p/>
2642 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002643 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2644 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2645 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002646 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2647 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002648 * @see RestrictionEntry
2649 */
2650 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2651 "android.intent.action.GET_RESTRICTION_ENTRIES";
2652
2653 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002654 * Sent the first time a user is starting, to allow system apps to
2655 * perform one time initialization. (This will not be seen by third
2656 * party applications because a newly initialized user does not have any
2657 * third party applications installed for it.) This is sent early in
2658 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002659 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2660 * broadcast, since it is part of a visible user interaction; be as quick
2661 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002662 */
2663 public static final String ACTION_USER_INITIALIZE =
2664 "android.intent.action.USER_INITIALIZE";
2665
2666 /**
2667 * Sent when a user switch is happening, causing the process's user to be
2668 * brought to the foreground. This is only sent to receivers registered
2669 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2670 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002671 * foreground. This is sent as a foreground
2672 * broadcast, since it is part of a visible user interaction; be as quick
2673 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002674 */
2675 public static final String ACTION_USER_FOREGROUND =
2676 "android.intent.action.USER_FOREGROUND";
2677
2678 /**
2679 * Sent when a user switch is happening, causing the process's user to be
2680 * sent to the background. This is only sent to receivers registered
2681 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2682 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002683 * background. This is sent as a foreground
2684 * broadcast, since it is part of a visible user interaction; be as quick
2685 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002686 */
2687 public static final String ACTION_USER_BACKGROUND =
2688 "android.intent.action.USER_BACKGROUND";
2689
2690 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002691 * Broadcast sent to the system when a user is added. Carries an extra
2692 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2693 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002694 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002695 * @hide
2696 */
2697 public static final String ACTION_USER_ADDED =
2698 "android.intent.action.USER_ADDED";
2699
2700 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002701 * Broadcast sent by the system when a user is started. Carries an extra
2702 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002703 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002704 * that has been started. This is sent as a foreground
2705 * broadcast, since it is part of a visible user interaction; be as quick
2706 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002707 * @hide
2708 */
2709 public static final String ACTION_USER_STARTED =
2710 "android.intent.action.USER_STARTED";
2711
2712 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002713 * Broadcast sent when a user is in the process of starting. Carries an extra
2714 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2715 * sent to registered receivers, not manifest receivers. It is sent to all
2716 * users (including the one that is being started). You must hold
2717 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2718 * this broadcast. This is sent as a background broadcast, since
2719 * its result is not part of the primary UX flow; to safely keep track of
2720 * started/stopped state of a user you can use this in conjunction with
2721 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2722 * other user state broadcasts since those are foreground broadcasts so can
2723 * execute in a different order.
2724 * @hide
2725 */
2726 public static final String ACTION_USER_STARTING =
2727 "android.intent.action.USER_STARTING";
2728
2729 /**
2730 * Broadcast sent when a user is going to be stopped. Carries an extra
2731 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2732 * sent to registered receivers, not manifest receivers. It is sent to all
2733 * users (including the one that is being stopped). You must hold
2734 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2735 * this broadcast. The user will not stop until all receivers have
2736 * handled the broadcast. This is sent as a background broadcast, since
2737 * its result is not part of the primary UX flow; to safely keep track of
2738 * started/stopped state of a user you can use this in conjunction with
2739 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2740 * other user state broadcasts since those are foreground broadcasts so can
2741 * execute in a different order.
2742 * @hide
2743 */
2744 public static final String ACTION_USER_STOPPING =
2745 "android.intent.action.USER_STOPPING";
2746
2747 /**
2748 * Broadcast sent to the system when a user is stopped. Carries an extra
2749 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2750 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2751 * specific package. This is only sent to registered receivers, not manifest
2752 * receivers. It is sent to all running users <em>except</em> the one that
2753 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002754 * @hide
2755 */
2756 public static final String ACTION_USER_STOPPED =
2757 "android.intent.action.USER_STOPPED";
2758
2759 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002760 * 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 -07002761 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002762 * one that has been removed. The user will not be completely removed until all receivers have
2763 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002764 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002765 * @hide
2766 */
2767 public static final String ACTION_USER_REMOVED =
2768 "android.intent.action.USER_REMOVED";
2769
2770 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002771 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002772 * the userHandle of the user to become the current one. This is only sent to
2773 * registered receivers, not manifest receivers. It is sent to all running users.
2774 * You must hold
2775 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002776 * @hide
2777 */
2778 public static final String ACTION_USER_SWITCHED =
2779 "android.intent.action.USER_SWITCHED";
2780
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002781 /**
2782 * Broadcast sent to the system when a user's information changes. Carries an extra
2783 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002784 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002785 * @hide
2786 */
2787 public static final String ACTION_USER_INFO_CHANGED =
2788 "android.intent.action.USER_INFO_CHANGED";
2789
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002790 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002791 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2792 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002793 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2794 * that need to display merged content across both primary and managed profiles need to
2795 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002796 * not manifest receivers.
2797 */
2798 public static final String ACTION_MANAGED_PROFILE_ADDED =
2799 "android.intent.action.MANAGED_PROFILE_ADDED";
2800
2801 /**
2802 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002803 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2804 * Only applications (for example Launchers) that need to display merged content across both
2805 * primary and managed profiles need to worry about this broadcast. This is only sent to
2806 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002807 */
2808 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2809 "android.intent.action.MANAGED_PROFILE_REMOVED";
2810
2811 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002812 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2813 */
2814 public static final String ACTION_QUICK_CLOCK =
2815 "android.intent.action.QUICK_CLOCK";
2816
Michael Wright0087a142013-02-05 16:29:39 -08002817 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002818 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002819 * @hide
2820 */
2821 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2822 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2823
Justin Kohd378ad72013-04-01 12:18:26 -07002824 /**
2825 * Broadcast Action: A global button was pressed. Includes a single
2826 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2827 * caused the broadcast.
2828 * @hide
2829 */
2830 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2831
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002832 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002833 * Activity Action: Allow the user to select and return one or more existing
2834 * documents. When invoked, the system will display the various
2835 * {@link DocumentsProvider} instances installed on the device, letting the
2836 * user interactively navigate through them. These documents include local
2837 * media, such as photos and video, and documents provided by installed
2838 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002839 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002840 * Each document is represented as a {@code content://} URI backed by a
2841 * {@link DocumentsProvider}, which can be opened as a stream with
2842 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2843 * {@link android.provider.DocumentsContract.Document} metadata.
2844 * <p>
2845 * All selected documents are returned to the calling application with
2846 * persistable read and write permission grants. If you want to maintain
2847 * access to the documents across device reboots, you need to explicitly
2848 * take the persistable permissions using
2849 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2850 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002851 * Callers must indicate the acceptable document MIME types through
2852 * {@link #setType(String)}. For example, to select photos, use
2853 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2854 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2855 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002856 * <p>
2857 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002858 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2859 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002860 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002861 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2862 * returned URIs can be opened with
2863 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002864 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002865 * Output: The URI of the item that was picked, returned in
2866 * {@link #getData()}. This must be a {@code content://} URI so that any
2867 * receiver can access it. If multiple documents were selected, they are
2868 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002869 *
2870 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002871 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002872 * @see #ACTION_CREATE_DOCUMENT
2873 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002874 */
2875 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2876 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2877
2878 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002879 * Activity Action: Allow the user to create a new document. When invoked,
2880 * the system will display the various {@link DocumentsProvider} instances
2881 * installed on the device, letting the user navigate through them. The
2882 * returned document may be a newly created document with no content, or it
2883 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002884 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002885 * Each document is represented as a {@code content://} URI backed by a
2886 * {@link DocumentsProvider}, which can be opened as a stream with
2887 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2888 * {@link android.provider.DocumentsContract.Document} metadata.
2889 * <p>
2890 * Callers must indicate the concrete MIME type of the document being
2891 * created by setting {@link #setType(String)}. This MIME type cannot be
2892 * changed after the document is created.
2893 * <p>
2894 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2895 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002896 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002897 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2898 * returned URIs can be opened with
2899 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002900 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002901 * Output: The URI of the item that was created. This must be a
2902 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002903 *
2904 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002905 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002906 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002907 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002908 */
2909 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2910 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2911
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002912 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002913 * Activity Action: Allow the user to pick a directory subtree. When
2914 * invoked, the system will display the various {@link DocumentsProvider}
2915 * instances installed on the device, letting the user navigate through
2916 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002917 * <p>
2918 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002919 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2920 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2921 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002922 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002923 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002924 *
2925 * @see DocumentsContract
2926 */
2927 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002928 public static final String
2929 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002930
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002931 /** {@hide} */
2932 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2933
Christopher Tate6597e342015-02-17 12:15:25 -08002934 /**
2935 * Broadcast action: report that a settings element is being restored from backup. The intent
2936 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
2937 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
2938 * is the value of that settings entry prior to the restore operation. All of these values are
2939 * represented as strings.
2940 *
2941 * <p>This broadcast is sent only for settings provider entries known to require special handling
2942 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
2943 * the provider's backup agent implementation.
2944 *
2945 * @see #EXTRA_SETTING_NAME
2946 * @see #EXTRA_SETTING_PREVIOUS_VALUE
2947 * @see #EXTRA_SETTING_NEW_VALUE
2948 * {@hide}
2949 */
2950 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
2951
2952 /** {@hide} */
2953 public static final String EXTRA_SETTING_NAME = "setting_name";
2954 /** {@hide} */
2955 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
2956 /** {@hide} */
2957 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
2958
Clara Bayarri0a26157a2015-03-26 18:38:55 +00002959 /**
2960 * Activity Action: Process a piece of text.
2961 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
2962 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
2963 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
2964 */
2965 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2966 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
2967 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01002968 * The name of the extra used to define the text to be processed, as a
2969 * CharSequence. Note that this may be a styled CharSequence, so you must use
2970 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00002971 */
2972 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
2973 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01002974 * The name of the boolean extra used to define if the processed text will be used as read-only.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00002975 */
2976 public static final String EXTRA_PROCESS_TEXT_READONLY =
2977 "android.intent.extra.PROCESS_TEXT_READONLY";
2978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002979 // ---------------------------------------------------------------------
2980 // ---------------------------------------------------------------------
2981 // Standard intent categories (see addCategory()).
2982
2983 /**
2984 * Set if the activity should be an option for the default action
2985 * (center press) to perform on a piece of data. Setting this will
2986 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002987 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002988 * Intent when initiating an action -- it is for use in intent filters
2989 * specified in packages.
2990 */
2991 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2992 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2993 /**
2994 * Activities that can be safely invoked from a browser must support this
2995 * category. For example, if the user is viewing a web page or an e-mail
2996 * and clicks on a link in the text, the Intent generated execute that
2997 * link will require the BROWSABLE category, so that only activities
2998 * supporting this category will be considered as possible actions. By
2999 * supporting this category, you are promising that there is nothing
3000 * damaging (without user intervention) that can happen by invoking any
3001 * matching Intent.
3002 */
3003 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3004 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3005 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003006 * Categories for activities that can participate in voice interaction.
3007 * An activity that supports this category must be prepared to run with
3008 * no UI shown at all (though in some case it may have a UI shown), and
3009 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3010 */
3011 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3012 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3013 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003014 * Set if the activity should be considered as an alternative action to
3015 * the data the user is currently viewing. See also
3016 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3017 * applies to the selection in a list of items.
3018 *
3019 * <p>Supporting this category means that you would like your activity to be
3020 * displayed in the set of alternative things the user can do, usually as
3021 * part of the current activity's options menu. You will usually want to
3022 * include a specific label in the &lt;intent-filter&gt; of this action
3023 * describing to the user what it does.
3024 *
3025 * <p>The action of IntentFilter with this category is important in that it
3026 * describes the specific action the target will perform. This generally
3027 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3028 * a specific name such as "com.android.camera.action.CROP. Only one
3029 * alternative of any particular action will be shown to the user, so using
3030 * a specific action like this makes sure that your alternative will be
3031 * displayed while also allowing other applications to provide their own
3032 * overrides of that particular action.
3033 */
3034 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3035 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3036 /**
3037 * Set if the activity should be considered as an alternative selection
3038 * action to the data the user has currently selected. This is like
3039 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3040 * of items from which the user can select, giving them alternatives to the
3041 * default action that will be performed on it.
3042 */
3043 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3044 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3045 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003046 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003047 */
3048 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3049 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3050 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003051 * Should be displayed in the top-level launcher.
3052 */
3053 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3054 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3055 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003056 * Indicates an activity optimized for Leanback mode, and that should
3057 * be displayed in the Leanback launcher.
3058 */
3059 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3060 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3061 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003062 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3063 * @hide
3064 */
3065 @SystemApi
3066 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3067 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003068 * Provides information about the package it is in; typically used if
3069 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3070 * a front-door to the user without having to be shown in the all apps list.
3071 */
3072 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3073 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3074 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003075 * This is the home activity, that is the first activity that is displayed
3076 * when the device boots.
3077 */
3078 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3079 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3080 /**
3081 * This activity is a preference panel.
3082 */
3083 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3084 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3085 /**
3086 * This activity is a development preference panel.
3087 */
3088 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3089 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3090 /**
3091 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003092 */
3093 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3094 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3095 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003096 * This activity allows the user to browse and download new applications.
3097 */
3098 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3099 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3100 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003101 * This activity may be exercised by the monkey or other automated test tools.
3102 */
3103 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3104 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3105 /**
3106 * To be used as a test (not part of the normal user experience).
3107 */
3108 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3109 /**
3110 * To be used as a unit test (run through the Test Harness).
3111 */
3112 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3113 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003114 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003115 * experience).
3116 */
3117 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003118
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003119 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003120 * Used to indicate that an intent only wants URIs that can be opened with
3121 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3122 * must support at least the columns defined in {@link OpenableColumns} when
3123 * queried.
3124 *
3125 * @see #ACTION_GET_CONTENT
3126 * @see #ACTION_OPEN_DOCUMENT
3127 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003128 */
3129 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3130 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3131
3132 /**
3133 * To be used as code under test for framework instrumentation tests.
3134 */
3135 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3136 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003137 /**
3138 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003139 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3140 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003141 */
3142 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3143 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3144 /**
3145 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003146 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3147 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003148 */
3149 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3150 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003151 /**
3152 * An activity to run when device is inserted into a analog (low end) dock.
3153 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3154 * information, see {@link android.app.UiModeManager}.
3155 */
3156 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3157 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3158
3159 /**
3160 * An activity to run when device is inserted into a digital (high end) dock.
3161 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3162 * information, see {@link android.app.UiModeManager}.
3163 */
3164 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3165 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003166
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003167 /**
3168 * Used to indicate that the activity can be used in a car environment.
3169 */
3170 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3171 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3172
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003173 // ---------------------------------------------------------------------
3174 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003175 // Application launch intent categories (see addCategory()).
3176
3177 /**
3178 * Used with {@link #ACTION_MAIN} to launch the browser application.
3179 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003180 * <p>NOTE: This should not be used as the primary key of an Intent,
3181 * since it will not result in the app launching with the correct
3182 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003183 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003184 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003185 */
3186 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3187 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3188
3189 /**
3190 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3191 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003192 * <p>NOTE: This should not be used as the primary key of an Intent,
3193 * since it will not result in the app launching with the correct
3194 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003195 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003196 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003197 */
3198 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3199 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3200
3201 /**
3202 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3203 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003204 * <p>NOTE: This should not be used as the primary key of an Intent,
3205 * since it will not result in the app launching with the correct
3206 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003207 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003208 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003209 */
3210 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3211 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3212
3213 /**
3214 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3215 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003216 * <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_CONTACTS = "android.intent.category.APP_CONTACTS";
3224
3225 /**
3226 * Used with {@link #ACTION_MAIN} to launch the email application.
3227 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003228 * <p>NOTE: This should not be used as the primary key of an Intent,
3229 * since it will not result in the app launching with the correct
3230 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003231 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003232 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003233 */
3234 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3235 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3236
3237 /**
3238 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3239 * The activity should be able to view and manipulate image and video files
3240 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003241 * <p>NOTE: This should not be used as the primary key of an Intent,
3242 * since it will not result in the app launching with the correct
3243 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003244 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003245 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003246 */
3247 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3248 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3249
3250 /**
3251 * Used with {@link #ACTION_MAIN} to launch the maps application.
3252 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003253 * <p>NOTE: This should not be used as the primary key of an Intent,
3254 * since it will not result in the app launching with the correct
3255 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003256 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003257 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003258 */
3259 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3260 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3261
3262 /**
3263 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3264 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003265 * <p>NOTE: This should not be used as the primary key of an Intent,
3266 * since it will not result in the app launching with the correct
3267 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003268 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003269 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003270 */
3271 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3272 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3273
3274 /**
3275 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003276 * The activity should be able to play, browse, or manipulate music files
3277 * stored on the device.
3278 * <p>NOTE: This should not be used as the primary key of an Intent,
3279 * since it will not result in the app launching with the correct
3280 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003281 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003282 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003283 */
3284 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3285 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3286
3287 // ---------------------------------------------------------------------
3288 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003289 // Standard extra data keys.
3290
3291 /**
3292 * The initial data to place in a newly created record. Use with
3293 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3294 * fields as would be given to the underlying ContentProvider.insert()
3295 * call.
3296 */
3297 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3298
3299 /**
3300 * A constant CharSequence that is associated with the Intent, used with
3301 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3302 * this may be a styled CharSequence, so you must use
3303 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3304 * retrieve it.
3305 */
3306 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3307
3308 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003309 * A constant String that is associated with the Intent, used with
3310 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3311 * as HTML formatted text. Note that you <em>must</em> also supply
3312 * {@link #EXTRA_TEXT}.
3313 */
3314 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3315
3316 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003317 * A content: URI holding a stream of data associated with the Intent,
3318 * used with {@link #ACTION_SEND} to supply the data being sent.
3319 */
3320 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3321
3322 /**
3323 * A String[] holding e-mail addresses that should be delivered to.
3324 */
3325 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3326
3327 /**
3328 * A String[] holding e-mail addresses that should be carbon copied.
3329 */
3330 public static final String EXTRA_CC = "android.intent.extra.CC";
3331
3332 /**
3333 * A String[] holding e-mail addresses that should be blind carbon copied.
3334 */
3335 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3336
3337 /**
3338 * A constant string holding the desired subject line of a message.
3339 */
3340 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3341
3342 /**
3343 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003344 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003345 */
3346 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3347
3348 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003349 * An Intent[] describing additional, alternate choices you would like shown with
3350 * {@link #ACTION_CHOOSER}.
3351 *
3352 * <p>An app may be capable of providing several different payload types to complete a
3353 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3354 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3355 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3356 * photo data or a hosted link where the photos can be viewed.</p>
3357 *
3358 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3359 * first/primary/preferred intent in the set. Additional intents specified in
3360 * this extra are ordered; by default intents that appear earlier in the array will be
3361 * preferred over intents that appear later in the array as matches for the same
3362 * target component. To alter this preference, a calling app may also supply
3363 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3364 */
3365 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3366
3367 /**
3368 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3369 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3370 *
3371 * <p>An app preparing an action for another app to complete may wish to allow the user to
3372 * disambiguate between several options for completing the action based on the chosen target
3373 * or otherwise refine the action before it is invoked.
3374 * </p>
3375 *
3376 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3377 * <ul>
3378 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3379 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3380 * chosen target beyond the first</li>
3381 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3382 * should fill in and send once the disambiguation is complete</li>
3383 * </ul>
3384 */
3385 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3386 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3387
3388 /**
3389 * A {@link ResultReceiver} used to return data back to the sender.
3390 *
3391 * <p>Used to complete an app-specific
3392 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3393 *
3394 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3395 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3396 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3397 * when the user selects a target component from the chooser. It is up to the recipient
3398 * to send a result to this ResultReceiver to signal that disambiguation is complete
3399 * and that the chooser should invoke the user's choice.</p>
3400 *
3401 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3402 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3403 * to match and fill in the final Intent or ChooserTarget before starting it.
3404 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3405 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3406 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3407 *
3408 * <p>The result code passed to the ResultReceiver should be
3409 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3410 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3411 * the chooser should finish without starting a target.</p>
3412 */
3413 public static final String EXTRA_RESULT_RECEIVER
3414 = "android.intent.extra.RESULT_RECEIVER";
3415
3416 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003418 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003419 */
3420 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3421
3422 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003423 * A Parcelable[] of {@link Intent} or
3424 * {@link android.content.pm.LabeledIntent} objects as set with
3425 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3426 * a the front of the list of choices, when shown to the user with a
3427 * {@link #ACTION_CHOOSER}.
3428 */
3429 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3430
3431 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003432 * A Bundle forming a mapping of potential target package names to different extras Bundles
3433 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3434 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3435 * be currently installed on the device.
3436 *
3437 * <p>An application may choose to provide alternate extras for the case where a user
3438 * selects an activity from a predetermined set of target packages. If the activity
3439 * the user selects from the chooser belongs to a package with its package name as
3440 * a key in this bundle, the corresponding extras for that package will be merged with
3441 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3442 * extra has the same key as an extra already present in the intent it will overwrite
3443 * the extra from the intent.</p>
3444 *
3445 * <p><em>Examples:</em>
3446 * <ul>
3447 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3448 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3449 * parameters for that target.</li>
3450 * <li>An application may offer additional metadata for known targets of a given intent
3451 * to pass along information only relevant to that target such as account or content
3452 * identifiers already known to that application.</li>
3453 * </ul></p>
3454 */
3455 public static final String EXTRA_REPLACEMENT_EXTRAS =
3456 "android.intent.extra.REPLACEMENT_EXTRAS";
3457
3458 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003459 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3460 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3461 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3462 * {@link ComponentName} of the chosen component.
3463 *
3464 * <p>In some situations this callback may never come, for example if the user abandons
3465 * the chooser, switches to another task or any number of other reasons. Apps should not
3466 * be written assuming that this callback will always occur.</p>
3467 */
3468 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3469 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3470
3471 /**
3472 * The {@link ComponentName} chosen by the user to complete an action.
3473 *
3474 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3475 */
3476 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3477
3478 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003479 * A {@link android.view.KeyEvent} object containing the event that
3480 * triggered the creation of the Intent it is in.
3481 */
3482 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3483
3484 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003485 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3486 * before shutting down.
3487 *
3488 * {@hide}
3489 */
3490 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3491
3492 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003493 * 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 -07003494 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3495 * of restarting the application.
3496 */
3497 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3498
3499 /**
3500 * A String holding the phone number originally entered in
3501 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3502 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3503 */
3504 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003505
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003506 /**
3507 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3508 * intents to supply the uid the package had been assigned. Also an optional
3509 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3510 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3511 * purpose.
3512 */
3513 public static final String EXTRA_UID = "android.intent.extra.UID";
3514
3515 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003516 * @hide String array of package names.
3517 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003518 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003519 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3520
3521 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003522 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3523 * intents to indicate whether this represents a full uninstall (removing
3524 * both the code and its data) or a partial uninstall (leaving its data,
3525 * implying that this is an update).
3526 */
3527 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003528
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003529 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003530 * @hide
3531 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3532 * intents to indicate that at this point the package has been removed for
3533 * all users on the device.
3534 */
3535 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3536 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3537
3538 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003539 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3540 * intents to indicate that this is a replacement of the package, so this
3541 * broadcast will immediately be followed by an add broadcast for a
3542 * different version of the same package.
3543 */
3544 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003545
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003546 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003547 * Used as an int extra field in {@link android.app.AlarmManager} intents
3548 * to tell the application being invoked how many pending alarms are being
3549 * delievered with the intent. For one-shot alarms this will always be 1.
3550 * For recurring alarms, this might be greater than 1 if the device was
3551 * asleep or powered off at the time an earlier alarm would have been
3552 * delivered.
3553 */
3554 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003555
Jacek Surazski86b6c532009-05-13 14:38:28 +02003556 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003557 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3558 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003559 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3560 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003561 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3562 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3563 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003564 */
3565 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3566
3567 /**
3568 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3569 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003570 */
3571 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3572
3573 /**
3574 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3575 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003576 */
3577 public static final int EXTRA_DOCK_STATE_DESK = 1;
3578
3579 /**
3580 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3581 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003582 */
3583 public static final int EXTRA_DOCK_STATE_CAR = 2;
3584
3585 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003586 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3587 * to represent that the phone is in a analog (low end) dock.
3588 */
3589 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3590
3591 /**
3592 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3593 * to represent that the phone is in a digital (high end) dock.
3594 */
3595 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3596
3597 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003598 * Boolean that can be supplied as meta-data with a dock activity, to
3599 * indicate that the dock should take over the home key when it is active.
3600 */
3601 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003602
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003603 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003604 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3605 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003606 */
3607 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3608
3609 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003610 * Used in the extra field in the remote intent. It's astring token passed with the
3611 * remote intent.
3612 */
3613 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3614 "android.intent.extra.remote_intent_token";
3615
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003616 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003617 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003618 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003619 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003620 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003621 "android.intent.extra.changed_component_name";
3622
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003623 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003624 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003625 * and contains a string array of all of the components that have changed. If
3626 * the state of the overall package has changed, then it will contain an entry
3627 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003628 */
3629 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3630 "android.intent.extra.changed_component_name_list";
3631
3632 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003633 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003634 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3635 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003636 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003637 */
3638 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3639 "android.intent.extra.changed_package_list";
3640
3641 /**
3642 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003643 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3644 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003645 * and contains an integer array of uids of all of the components
3646 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003647 */
3648 public static final String EXTRA_CHANGED_UID_LIST =
3649 "android.intent.extra.changed_uid_list";
3650
3651 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003652 * @hide
3653 * Magic extra system code can use when binding, to give a label for
3654 * who it is that has bound to a service. This is an integer giving
3655 * a framework string resource that can be displayed to the user.
3656 */
3657 public static final String EXTRA_CLIENT_LABEL =
3658 "android.intent.extra.client_label";
3659
3660 /**
3661 * @hide
3662 * Magic extra system code can use when binding, to give a PendingIntent object
3663 * that can be launched for the user to disable the system's use of this
3664 * service.
3665 */
3666 public static final String EXTRA_CLIENT_INTENT =
3667 "android.intent.extra.client_intent";
3668
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003669 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003670 * Extra used to indicate that an intent should only return data that is on
3671 * the local device. This is a boolean extra; the default is false. If true,
3672 * an implementation should only allow the user to select data that is
3673 * already on the device, not requiring it be downloaded from a remote
3674 * service when opened.
3675 *
3676 * @see #ACTION_GET_CONTENT
3677 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003678 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003679 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003680 */
3681 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003682 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003683
Amith Yamasani13593602012-03-22 16:16:17 -07003684 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003685 * Extra used to indicate that an intent can allow the user to select and
3686 * return multiple items. This is a boolean extra; the default is false. If
3687 * true, an implementation is allowed to present the user with a UI where
3688 * they can pick multiple items that are all returned to the caller. When
3689 * this happens, they should be returned as the {@link #getClipData()} part
3690 * of the result Intent.
3691 *
3692 * @see #ACTION_GET_CONTENT
3693 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003694 */
3695 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003696 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003697
3698 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003699 * The integer userHandle carried with broadcast intents related to addition, removal and
3700 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3701 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3702 *
Amith Yamasani13593602012-03-22 16:16:17 -07003703 * @hide
3704 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003705 public static final String EXTRA_USER_HANDLE =
3706 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003707
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003708 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003709 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3710 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3711 */
3712 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003713 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003714
3715 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003716 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003717 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3718 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003719 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003720 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3721
3722 /**
3723 * Extra sent in the intent to the BroadcastReceiver that handles
3724 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3725 * the restrictions as key/value pairs.
3726 */
3727 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3728 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003729
Amith Yamasani86118ba2013-03-28 14:33:16 -07003730 /**
3731 * Extra used in the response from a BroadcastReceiver that handles
3732 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3733 */
3734 public static final String EXTRA_RESTRICTIONS_INTENT =
3735 "android.intent.extra.restrictions_intent";
3736
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003737 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003738 * Extra used to communicate a set of acceptable MIME types. The type of the
3739 * extra is {@code String[]}. Values may be a combination of concrete MIME
3740 * types (such as "image/png") and/or partial MIME types (such as
3741 * "audio/*").
3742 *
3743 * @see #ACTION_GET_CONTENT
3744 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003745 */
3746 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3747
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003748 /**
3749 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3750 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003751 * When this is true, hardware devices can use this information to determine that
3752 * they shouldn't do a complete shutdown of their device since this is not a
3753 * complete shutdown down to the kernel, but only user space restarting.
3754 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003755 */
3756 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3757 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3758
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003759 /**
3760 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3761 * user has set their time format preferences to the 24 hour format.
3762 *
3763 * @hide for internal use only.
3764 */
3765 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3766 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3767
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003768 /** {@hide} */
3769 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3770
Santos Cordon15a13782015-03-31 18:32:31 -07003771 /**
3772 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
3773 * activation request.
3774 * TODO: Add information about the structure and response data used with the pending intent.
3775 * @hide
3776 */
3777 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
3778 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
3779
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003780 // ---------------------------------------------------------------------
3781 // ---------------------------------------------------------------------
3782 // Intent flags (see mFlags variable).
3783
Tor Norbyed9273d62013-05-30 15:59:53 -07003784 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003785 @IntDef(flag = true, value = {
3786 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3787 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003788 @Retention(RetentionPolicy.SOURCE)
3789 public @interface GrantUriMode {}
3790
Jeff Sharkey846318a2014-04-04 12:12:41 -07003791 /** @hide */
3792 @IntDef(flag = true, value = {
3793 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3794 @Retention(RetentionPolicy.SOURCE)
3795 public @interface AccessUriMode {}
3796
3797 /**
3798 * Test if given mode flags specify an access mode, which must be at least
3799 * read and/or write.
3800 *
3801 * @hide
3802 */
3803 public static boolean isAccessUriMode(int modeFlags) {
3804 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3805 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3806 }
3807
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003808 /**
3809 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003810 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003811 * specified in its ClipData. When applying to an Intent's ClipData,
3812 * all URIs as well as recursive traversals through data or other ClipData
3813 * in Intent items will be granted; only the grant flags of the top-level
3814 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003815 */
3816 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3817 /**
3818 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003819 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003820 * specified in its ClipData. When applying to an Intent's ClipData,
3821 * all URIs as well as recursive traversals through data or other ClipData
3822 * in Intent items will be granted; only the grant flags of the top-level
3823 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003824 */
3825 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3826 /**
3827 * Can be set by the caller to indicate that this Intent is coming from
3828 * a background operation, not from direct user interaction.
3829 */
3830 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3831 /**
3832 * A flag you can enable for debugging: when set, log messages will be
3833 * printed during the resolution of this intent to show you what has
3834 * been found to create the final resolved list.
3835 */
3836 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003837 /**
3838 * If set, this intent will not match any components in packages that
3839 * are currently stopped. If this is not set, then the default behavior
3840 * is to include such applications in the result.
3841 */
3842 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3843 /**
3844 * If set, this intent will always match any components in packages that
3845 * are currently stopped. This is the default behavior when
3846 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3847 * flags are set, this one wins (it allows overriding of exclude for
3848 * places where the framework may automatically set the exclude flag).
3849 */
3850 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003851
3852 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003853 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003854 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003855 * persisted across device reboots until explicitly revoked with
3856 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3857 * grant for possible persisting; the receiving application must call
3858 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3859 * actually persist.
3860 *
3861 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3862 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3863 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003864 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003865 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003866 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003867
3868 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003869 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3870 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3871 * applies to any URI that is a prefix match against the original granted
3872 * URI. (Without this flag, the URI must match exactly for access to be
3873 * granted.) Another URI is considered a prefix match only when scheme,
3874 * authority, and all path segments defined by the prefix are an exact
3875 * match.
3876 */
3877 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3878
3879 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003880 * If set, the new activity is not kept in the history stack. As soon as
3881 * the user navigates away from it, the activity is finished. This may also
3882 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3883 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07003884 *
3885 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
3886 * is never invoked when the current activity starts a new activity which
3887 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003888 */
3889 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3890 /**
3891 * If set, the activity will not be launched if it is already running
3892 * at the top of the history stack.
3893 */
3894 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3895 /**
3896 * If set, this activity will become the start of a new task on this
3897 * history stack. A task (from the activity that started it to the
3898 * next task activity) defines an atomic group of activities that the
3899 * user can move to. Tasks can be moved to the foreground and background;
3900 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003901 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003902 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3903 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003904 *
3905 * <p>This flag is generally used by activities that want
3906 * to present a "launcher" style behavior: they give the user a list of
3907 * separate things that can be done, which otherwise run completely
3908 * independently of the activity launching them.
3909 *
3910 * <p>When using this flag, if a task is already running for the activity
3911 * you are now starting, then a new activity will not be started; instead,
3912 * the current task will simply be brought to the front of the screen with
3913 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3914 * to disable this behavior.
3915 *
3916 * <p>This flag can not be used when the caller is requesting a result from
3917 * the activity being launched.
3918 */
3919 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3920 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003921 * This flag is used to create a new task and launch an activity into it.
3922 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3923 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3924 * search through existing tasks for ones matching this Intent. Only if no such
3925 * task is found would a new task be created. When paired with
3926 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3927 * the search for a matching task and unconditionally start a new task.
3928 *
3929 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3930 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003931 * top-level application launcher.</strong> Used in conjunction with
3932 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3933 * behavior of bringing an existing task to the foreground. When set,
3934 * a new task is <em>always</em> started to host the Activity for the
3935 * Intent, regardless of whether there is already an existing task running
3936 * the same thing.
3937 *
3938 * <p><strong>Because the default system does not include graphical task management,
3939 * you should not use this flag unless you provide some way for a user to
3940 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003941 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003942 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3943 * creating new document tasks.
3944 *
3945 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003946 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003947 *
Scott Main7aee61f2011-02-08 11:25:01 -08003948 * <p>See
3949 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3950 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003951 *
3952 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3953 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003954 */
3955 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3956 /**
3957 * If set, and the activity being launched is already running in the
3958 * current task, then instead of launching a new instance of that activity,
3959 * all of the other activities on top of it will be closed and this Intent
3960 * will be delivered to the (now on top) old activity as a new Intent.
3961 *
3962 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3963 * If D calls startActivity() with an Intent that resolves to the component
3964 * of activity B, then C and D will be finished and B receive the given
3965 * Intent, resulting in the stack now being: A, B.
3966 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003967 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003968 * either receive the new intent you are starting here in its
3969 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003970 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003971 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3972 * the same intent, then it will be finished and re-created; for all other
3973 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3974 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003975 *
3976 * <p>This launch mode can also be used to good effect in conjunction with
3977 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3978 * of a task, it will bring any currently running instance of that task
3979 * to the foreground, and then clear it to its root state. This is
3980 * especially useful, for example, when launching an activity from the
3981 * notification manager.
3982 *
Scott Main7aee61f2011-02-08 11:25:01 -08003983 * <p>See
3984 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3985 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003986 */
3987 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3988 /**
3989 * If set and this intent is being used to launch a new activity from an
3990 * existing one, then the reply target of the existing activity will be
3991 * transfered to the new activity. This way the new activity can call
3992 * {@link android.app.Activity#setResult} and have that result sent back to
3993 * the reply target of the original activity.
3994 */
3995 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3996 /**
3997 * If set and this intent is being used to launch a new activity from an
3998 * existing one, the current activity will not be counted as the top
3999 * activity for deciding whether the new intent should be delivered to
4000 * the top instead of starting a new one. The previous activity will
4001 * be used as the top, with the assumption being that the current activity
4002 * will finish itself immediately.
4003 */
4004 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4005 /**
4006 * If set, the new activity is not kept in the list of recently launched
4007 * activities.
4008 */
4009 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4010 /**
4011 * This flag is not normally set by application code, but set for you by
4012 * the system as described in the
4013 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4014 * launchMode} documentation for the singleTask mode.
4015 */
4016 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4017 /**
4018 * If set, and this activity is either being started in a new task or
4019 * bringing to the top an existing task, then it will be launched as
4020 * the front door of the task. This will result in the application of
4021 * any affinities needed to have that task in the proper state (either
4022 * moving activities to or from it), or simply resetting that task to
4023 * its initial state if needed.
4024 */
4025 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4026 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004027 * This flag is not normally set by application code, but set for you by
4028 * the system if this activity is being launched from history
4029 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004030 */
4031 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004032 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004033 * @deprecated As of API 21 this performs identically to
4034 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004035 */
4036 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004037 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004038 * This flag is used to open a document into a new task rooted at the activity launched
4039 * by this Intent. Through the use of this flag, or its equivalent attribute,
4040 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004041 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004042 *
Craig Mautner026596b2014-05-21 15:35:44 -07004043 * <p>The use of the activity attribute form of this,
4044 * {@link android.R.attr#documentLaunchMode}, is
4045 * preferred over the Intent flag described here. The attribute form allows the
4046 * Activity to specify multiple document behavior for all launchers of the Activity
4047 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004048 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004049 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4050 * it is kept after the activity is finished is different than the use of
4051 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4052 * this flag is being used to create a new recents entry, then by default that entry
4053 * will be removed once the activity is finished. You can modify this behavior with
4054 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4055 *
Craig Mautner026596b2014-05-21 15:35:44 -07004056 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4057 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4058 * equivalent of the Activity manifest specifying {@link
4059 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4060 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4061 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004062 *
Craig Mautner026596b2014-05-21 15:35:44 -07004063 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004064 *
Craig Mautner026596b2014-05-21 15:35:44 -07004065 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004066 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4067 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004068 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004069 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004070 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004071 * callback from occurring on the current frontmost activity before it is
4072 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004073 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004074 * <p>Typically, an activity can rely on that callback to indicate that an
4075 * explicit user action has caused their activity to be moved out of the
4076 * foreground. The callback marks an appropriate point in the activity's
4077 * lifecycle for it to dismiss any notifications that it intends to display
4078 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004079 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004080 * <p>If an activity is ever started via any non-user-driven events such as
4081 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4082 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004083 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004084 */
4085 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004086 /**
4087 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4088 * this flag will cause the launched activity to be brought to the front of its
4089 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004090 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004091 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4092 * If D calls startActivity() with an Intent that resolves to the component
4093 * of activity B, then B will be brought to the front of the history stack,
4094 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004095 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004096 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004097 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004098 */
4099 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004100 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004101 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4102 * this flag will prevent the system from applying an activity transition
4103 * animation to go to the next activity state. This doesn't mean an
4104 * animation will never run -- if another activity change happens that doesn't
4105 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004106 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004107 * when you are going to do a series of activity operations but the
4108 * animation seen by the user shouldn't be driven by the first activity
4109 * change but rather a later one.
4110 */
4111 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4112 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004113 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4114 * this flag will cause any existing task that would be associated with the
4115 * activity to be cleared before the activity is started. That is, the activity
4116 * becomes the new root of an otherwise empty task, and any old activities
4117 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4118 */
4119 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4120 /**
4121 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4122 * this flag will cause a newly launching task to be placed on top of the current
4123 * home activity task (if there is one). That is, pressing back from the task
4124 * will always return the user to home even if that was not the last activity they
4125 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4126 */
4127 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4128 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004129 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4130 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004131 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004132 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004133 * this flag. When set and the task's activity is finished, the recents
4134 * entry will remain in the interface for the user to re-launch it, like a
4135 * recents entry for a top-level application.
4136 * <p>
4137 * The receiving activity can override this request with
4138 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4139 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004140 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004141 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004142 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004143
4144 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004145 * If set, when sending a broadcast only registered receivers will be
4146 * called -- no BroadcastReceiver components will be launched.
4147 */
4148 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004149 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004150 * If set, when sending a broadcast the new broadcast will replace
4151 * any existing pending broadcast that matches it. Matching is defined
4152 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4153 * true for the intents of the two broadcasts. When a match is found,
4154 * the new broadcast (and receivers associated with it) will replace the
4155 * existing one in the pending broadcast list, remaining at the same
4156 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004157 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004158 * <p>This flag is most typically used with sticky broadcasts, which
4159 * only care about delivering the most recent values of the broadcast
4160 * to their receivers.
4161 */
4162 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4163 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004164 * If set, when sending a broadcast the recipient is allowed to run at
4165 * foreground priority, with a shorter timeout interval. During normal
4166 * broadcasts the receivers are not automatically hoisted out of the
4167 * background priority class.
4168 */
4169 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4170 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004171 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4172 * They can still propagate results through to later receivers, but they can not prevent
4173 * later receivers from seeing the broadcast.
4174 */
4175 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4176 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004177 * If set, when sending a broadcast <i>before boot has completed</i> only
4178 * registered receivers will be called -- no BroadcastReceiver components
4179 * will be launched. Sticky intent state will be recorded properly even
4180 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4181 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004182 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004183 * <p>This flag is only for use by system sevices as a convenience to
4184 * avoid having to implement a more complex mechanism around detection
4185 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004186 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004187 * @hide
4188 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004189 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004190 /**
4191 * Set when this broadcast is for a boot upgrade, a special mode that
4192 * allows the broadcast to be sent before the system is ready and launches
4193 * the app process with no providers running in it.
4194 * @hide
4195 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004196 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004197
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004198 /**
4199 * @hide Flags that can't be changed with PendingIntent.
4200 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004201 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4202 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4203 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004204
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004205 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004206 // ---------------------------------------------------------------------
4207 // toUri() and parseUri() options.
4208
4209 /**
4210 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4211 * always has the "intent:" scheme. This syntax can be used when you want
4212 * to later disambiguate between URIs that are intended to describe an
4213 * Intent vs. all others that should be treated as raw URIs. When used
4214 * with {@link #parseUri}, any other scheme will result in a generic
4215 * VIEW action for that raw URI.
4216 */
4217 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004218
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004219 /**
4220 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4221 * always has the "android-app:" scheme. This is a variation of
4222 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4223 * http/https URI being delivered to a specific package name. The format
4224 * is:
4225 *
4226 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004227 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004228 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004229 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4230 * you must also include a scheme; including a path also requires both a host and a scheme.
4231 * The final #Intent; fragment can be used without a scheme, host, or path.
4232 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004233 * used with intents that have a {@link #setSelector}, since the base intent
4234 * will always have an explicit package name.</p>
4235 *
4236 * <p>Some examples of how this scheme maps to Intent objects:</p>
4237 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4238 * <colgroup align="left" />
4239 * <colgroup align="left" />
4240 * <thead>
4241 * <tr><th>URI</th> <th>Intent</th></tr>
4242 * </thead>
4243 *
4244 * <tbody>
4245 * <tr><td><code>android-app://com.example.app</code></td>
4246 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4247 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4248 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4249 * </table></td>
4250 * </tr>
4251 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4252 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4253 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4254 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4255 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4256 * </table></td>
4257 * </tr>
4258 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4259 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4260 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4261 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4262 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4263 * </table></td>
4264 * </tr>
4265 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4266 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4267 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4268 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4269 * </table></td>
4270 * </tr>
4271 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4272 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4273 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4274 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4275 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4276 * </table></td>
4277 * </tr>
4278 * <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>
4279 * <td><table border="" style="margin:0" >
4280 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4281 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4282 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4283 * </table></td>
4284 * </tr>
4285 * </tbody>
4286 * </table>
4287 */
4288 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4289
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004290 /**
4291 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4292 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4293 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4294 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4295 * generated Intent can not cause unexpected data access to happen.
4296 *
4297 * <p>If you do not trust the source of the URI being parsed, you should still do further
4298 * processing to protect yourself from it. In particular, when using it to start an
4299 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4300 * that can handle it.</p>
4301 */
4302 public static final int URI_ALLOW_UNSAFE = 1<<2;
4303
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004304 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004305
4306 private String mAction;
4307 private Uri mData;
4308 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004309 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004310 private ComponentName mComponent;
4311 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004312 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004313 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004314 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004315 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004316 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004317 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004318
4319 // ---------------------------------------------------------------------
4320
4321 /**
4322 * Create an empty intent.
4323 */
4324 public Intent() {
4325 }
4326
4327 /**
4328 * Copy constructor.
4329 */
4330 public Intent(Intent o) {
4331 this.mAction = o.mAction;
4332 this.mData = o.mData;
4333 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004334 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004335 this.mComponent = o.mComponent;
4336 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004337 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004338 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004339 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004340 }
4341 if (o.mExtras != null) {
4342 this.mExtras = new Bundle(o.mExtras);
4343 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004344 if (o.mSourceBounds != null) {
4345 this.mSourceBounds = new Rect(o.mSourceBounds);
4346 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004347 if (o.mSelector != null) {
4348 this.mSelector = new Intent(o.mSelector);
4349 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004350 if (o.mClipData != null) {
4351 this.mClipData = new ClipData(o.mClipData);
4352 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004353 }
4354
4355 @Override
4356 public Object clone() {
4357 return new Intent(this);
4358 }
4359
4360 private Intent(Intent o, boolean all) {
4361 this.mAction = o.mAction;
4362 this.mData = o.mData;
4363 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004364 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004365 this.mComponent = o.mComponent;
4366 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004367 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004368 }
4369 }
4370
4371 /**
4372 * Make a clone of only the parts of the Intent that are relevant for
4373 * filter matching: the action, data, type, component, and categories.
4374 */
4375 public Intent cloneFilter() {
4376 return new Intent(this, false);
4377 }
4378
4379 /**
4380 * Create an intent with a given action. All other fields (data, type,
4381 * class) are null. Note that the action <em>must</em> be in a
4382 * namespace because Intents are used globally in the system -- for
4383 * example the system VIEW action is android.intent.action.VIEW; an
4384 * application's custom action would be something like
4385 * com.google.app.myapp.CUSTOM_ACTION.
4386 *
4387 * @param action The Intent action, such as ACTION_VIEW.
4388 */
4389 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004390 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 }
4392
4393 /**
4394 * Create an intent with a given action and for a given data url. Note
4395 * that the action <em>must</em> be in a namespace because Intents are
4396 * used globally in the system -- for example the system VIEW action is
4397 * android.intent.action.VIEW; an application's custom action would be
4398 * something like com.google.app.myapp.CUSTOM_ACTION.
4399 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004400 * <p><em>Note: scheme and host name matching in the Android framework is
4401 * case-sensitive, unlike the formal RFC. As a result,
4402 * you should always ensure that you write your Uri with these elements
4403 * using lower case letters, and normalize any Uris you receive from
4404 * outside of Android to ensure the scheme and host is lower case.</em></p>
4405 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004406 * @param action The Intent action, such as ACTION_VIEW.
4407 * @param uri The Intent data URI.
4408 */
4409 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004410 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004411 mData = uri;
4412 }
4413
4414 /**
4415 * Create an intent for a specific component. All other fields (action, data,
4416 * type, class) are null, though they can be modified later with explicit
4417 * calls. This provides a convenient way to create an intent that is
4418 * intended to execute a hard-coded class name, rather than relying on the
4419 * system to find an appropriate class for you; see {@link #setComponent}
4420 * for more information on the repercussions of this.
4421 *
4422 * @param packageContext A Context of the application package implementing
4423 * this class.
4424 * @param cls The component class that is to be used for the intent.
4425 *
4426 * @see #setClass
4427 * @see #setComponent
4428 * @see #Intent(String, android.net.Uri , Context, Class)
4429 */
4430 public Intent(Context packageContext, Class<?> cls) {
4431 mComponent = new ComponentName(packageContext, cls);
4432 }
4433
4434 /**
4435 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004436 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004437 * construct the Intent and then calling {@link #setClass} to set its
4438 * class.
4439 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004440 * <p><em>Note: scheme and host name matching in the Android framework is
4441 * case-sensitive, unlike the formal RFC. As a result,
4442 * you should always ensure that you write your Uri with these elements
4443 * using lower case letters, and normalize any Uris you receive from
4444 * outside of Android to ensure the scheme and host is lower case.</em></p>
4445 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004446 * @param action The Intent action, such as ACTION_VIEW.
4447 * @param uri The Intent data URI.
4448 * @param packageContext A Context of the application package implementing
4449 * this class.
4450 * @param cls The component class that is to be used for the intent.
4451 *
4452 * @see #Intent(String, android.net.Uri)
4453 * @see #Intent(Context, Class)
4454 * @see #setClass
4455 * @see #setComponent
4456 */
4457 public Intent(String action, Uri uri,
4458 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004459 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004460 mData = uri;
4461 mComponent = new ComponentName(packageContext, cls);
4462 }
4463
4464 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004465 * Create an intent to launch the main (root) activity of a task. This
4466 * is the Intent that is started when the application's is launched from
4467 * Home. For anything else that wants to launch an application in the
4468 * same way, it is important that they use an Intent structured the same
4469 * way, and can use this function to ensure this is the case.
4470 *
4471 * <p>The returned Intent has the given Activity component as its explicit
4472 * component, {@link #ACTION_MAIN} as its action, and includes the
4473 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4474 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4475 * to do that through {@link #addFlags(int)} on the returned Intent.
4476 *
4477 * @param mainActivity The main activity component that this Intent will
4478 * launch.
4479 * @return Returns a newly created Intent that can be used to launch the
4480 * activity as a main application entry.
4481 *
4482 * @see #setClass
4483 * @see #setComponent
4484 */
4485 public static Intent makeMainActivity(ComponentName mainActivity) {
4486 Intent intent = new Intent(ACTION_MAIN);
4487 intent.setComponent(mainActivity);
4488 intent.addCategory(CATEGORY_LAUNCHER);
4489 return intent;
4490 }
4491
4492 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004493 * Make an Intent for the main activity of an application, without
4494 * specifying a specific activity to run but giving a selector to find
4495 * the activity. This results in a final Intent that is structured
4496 * the same as when the application is launched from
4497 * Home. For anything else that wants to launch an application in the
4498 * same way, it is important that they use an Intent structured the same
4499 * way, and can use this function to ensure this is the case.
4500 *
4501 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4502 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4503 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4504 * to do that through {@link #addFlags(int)} on the returned Intent.
4505 *
4506 * @param selectorAction The action name of the Intent's selector.
4507 * @param selectorCategory The name of a category to add to the Intent's
4508 * selector.
4509 * @return Returns a newly created Intent that can be used to launch the
4510 * activity as a main application entry.
4511 *
4512 * @see #setSelector(Intent)
4513 */
4514 public static Intent makeMainSelectorActivity(String selectorAction,
4515 String selectorCategory) {
4516 Intent intent = new Intent(ACTION_MAIN);
4517 intent.addCategory(CATEGORY_LAUNCHER);
4518 Intent selector = new Intent();
4519 selector.setAction(selectorAction);
4520 selector.addCategory(selectorCategory);
4521 intent.setSelector(selector);
4522 return intent;
4523 }
4524
4525 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004526 * Make an Intent that can be used to re-launch an application's task
4527 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4528 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4529 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4530 *
4531 * @param mainActivity The activity component that is the root of the
4532 * task; this is the activity that has been published in the application's
4533 * manifest as the main launcher icon.
4534 *
4535 * @return Returns a newly created Intent that can be used to relaunch the
4536 * activity's task in its root state.
4537 */
4538 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4539 Intent intent = makeMainActivity(mainActivity);
4540 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4541 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4542 return intent;
4543 }
4544
4545 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004546 * Call {@link #parseUri} with 0 flags.
4547 * @deprecated Use {@link #parseUri} instead.
4548 */
4549 @Deprecated
4550 public static Intent getIntent(String uri) throws URISyntaxException {
4551 return parseUri(uri, 0);
4552 }
Tom Taylord4a47292009-12-21 13:59:18 -08004553
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004554 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004555 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004556 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004557 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004558 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004559 *
4560 * <p>The URI given here must not be relative -- that is, it must include
4561 * the scheme and full path.
4562 *
4563 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004564 * @param flags Additional processing flags. Either 0,
4565 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004566 *
4567 * @return Intent The newly created Intent object.
4568 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004569 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4570 * it bad (as parsed by the Uri class) or the Intent data within the
4571 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004572 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004573 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004574 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004575 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004576 int i = 0;
4577 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004578 final boolean androidApp = uri.startsWith("android-app:");
4579
4580 // Validate intent scheme if requested.
4581 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4582 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004583 Intent intent = new Intent(ACTION_VIEW);
4584 try {
4585 intent.setData(Uri.parse(uri));
4586 } catch (IllegalArgumentException e) {
4587 throw new URISyntaxException(uri, e.getMessage());
4588 }
4589 return intent;
4590 }
4591 }
Tom Taylord4a47292009-12-21 13:59:18 -08004592
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004593 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004594 // simple case
4595 if (i == -1) {
4596 if (!androidApp) {
4597 return new Intent(ACTION_VIEW, Uri.parse(uri));
4598 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004599
4600 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004601 } else if (!uri.startsWith("#Intent;", i)) {
4602 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004603 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004604 } else {
4605 i = -1;
4606 }
4607 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004608
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004609 // new format
4610 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004611 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004612 boolean explicitAction = false;
4613 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004614
4615 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004616 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004617 String data;
4618 if (i >= 0) {
4619 data = uri.substring(0, i);
4620 i += 8; // length of "#Intent;"
4621 } else {
4622 data = uri;
4623 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004625 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004626 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004627 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004628 if (eq < 0) eq = i-1;
4629 int semi = uri.indexOf(';', i);
4630 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004631
4632 // action
4633 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004634 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004635 if (!inSelector) {
4636 explicitAction = true;
4637 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004638 }
4639
4640 // categories
4641 else if (uri.startsWith("category=", i)) {
4642 intent.addCategory(value);
4643 }
4644
4645 // type
4646 else if (uri.startsWith("type=", i)) {
4647 intent.mType = value;
4648 }
4649
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004650 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004651 else if (uri.startsWith("launchFlags=", i)) {
4652 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004653 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4654 intent.mFlags &= ~IMMUTABLE_FLAGS;
4655 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004656 }
4657
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004658 // package
4659 else if (uri.startsWith("package=", i)) {
4660 intent.mPackage = value;
4661 }
4662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004663 // component
4664 else if (uri.startsWith("component=", i)) {
4665 intent.mComponent = ComponentName.unflattenFromString(value);
4666 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004667
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004668 // scheme
4669 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004670 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004671 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004672 } else {
4673 scheme = value;
4674 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004675 }
4676
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004677 // source bounds
4678 else if (uri.startsWith("sourceBounds=", i)) {
4679 intent.mSourceBounds = Rect.unflattenFromString(value);
4680 }
4681
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004682 // selector
4683 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4684 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004685 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004686 }
4687
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004688 // extra
4689 else {
4690 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004691 // create Bundle if it doesn't already exist
4692 if (intent.mExtras == null) intent.mExtras = new Bundle();
4693 Bundle b = intent.mExtras;
4694 // add EXTRA
4695 if (uri.startsWith("S.", i)) b.putString(key, value);
4696 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4697 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4698 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4699 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4700 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4701 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4702 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4703 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4704 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4705 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004706
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004707 // move to the next item
4708 i = semi + 1;
4709 }
4710
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004711 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004712 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004713 if (baseIntent.mPackage == null) {
4714 baseIntent.setSelector(intent);
4715 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004716 intent = baseIntent;
4717 }
4718
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004719 if (data != null) {
4720 if (data.startsWith("intent:")) {
4721 data = data.substring(7);
4722 if (scheme != null) {
4723 data = scheme + ':' + data;
4724 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004725 } else if (data.startsWith("android-app:")) {
4726 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
4727 // Correctly formed android-app, first part is package name.
4728 int end = data.indexOf('/', 14);
4729 if (end < 0) {
4730 // All we have is a package name.
4731 intent.mPackage = data.substring(14);
4732 if (!explicitAction) {
4733 intent.setAction(ACTION_MAIN);
4734 }
4735 data = "";
4736 } else {
4737 // Target the Intent at the given package name always.
4738 String authority = null;
4739 intent.mPackage = data.substring(14, end);
4740 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004741 if ((end+1) < data.length()) {
4742 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
4743 // Found a scheme, remember it.
4744 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004745 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004746 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
4747 // Found a authority, remember it.
4748 authority = data.substring(end+1, newEnd);
4749 end = newEnd;
4750 }
4751 } else {
4752 // All we have is a scheme.
4753 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004754 }
4755 }
4756 if (scheme == null) {
4757 // If there was no scheme, then this just targets the package.
4758 if (!explicitAction) {
4759 intent.setAction(ACTION_MAIN);
4760 }
4761 data = "";
4762 } else if (authority == null) {
4763 data = scheme + ":";
4764 } else {
4765 data = scheme + "://" + authority + data.substring(end);
4766 }
4767 }
4768 } else {
4769 data = "";
4770 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004771 }
Tom Taylord4a47292009-12-21 13:59:18 -08004772
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004773 if (data.length() > 0) {
4774 try {
4775 intent.mData = Uri.parse(data);
4776 } catch (IllegalArgumentException e) {
4777 throw new URISyntaxException(uri, e.getMessage());
4778 }
4779 }
4780 }
Tom Taylord4a47292009-12-21 13:59:18 -08004781
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004782 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004783
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004784 } catch (IndexOutOfBoundsException e) {
4785 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4786 }
4787 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004788
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004789 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004790 return getIntentOld(uri, 0);
4791 }
4792
4793 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004794 Intent intent;
4795
4796 int i = uri.lastIndexOf('#');
4797 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004798 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004799 final int intentFragmentStart = i;
4800 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004801
4802 i++;
4803
4804 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004805 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004806 i += 7;
4807 int j = uri.indexOf(')', i);
4808 action = uri.substring(i, j);
4809 i = j + 1;
4810 }
4811
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004812 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004813
4814 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004815 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004816 i += 11;
4817 int j = uri.indexOf(')', i);
4818 while (i < j) {
4819 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004820 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004821 if (i < sep) {
4822 intent.addCategory(uri.substring(i, sep));
4823 }
4824 i = sep + 1;
4825 }
4826 i = j + 1;
4827 }
4828
4829 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004830 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004831 i += 5;
4832 int j = uri.indexOf(')', i);
4833 intent.mType = uri.substring(i, j);
4834 i = j + 1;
4835 }
4836
4837 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004838 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004839 i += 12;
4840 int j = uri.indexOf(')', i);
4841 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004842 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4843 intent.mFlags &= ~IMMUTABLE_FLAGS;
4844 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004845 i = j + 1;
4846 }
4847
4848 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004849 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004850 i += 10;
4851 int j = uri.indexOf(')', i);
4852 int sep = uri.indexOf('!', i);
4853 if (sep >= 0 && sep < j) {
4854 String pkg = uri.substring(i, sep);
4855 String cls = uri.substring(sep + 1, j);
4856 intent.mComponent = new ComponentName(pkg, cls);
4857 }
4858 i = j + 1;
4859 }
4860
4861 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004862 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004863 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004864
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004865 final int closeParen = uri.indexOf(')', i);
4866 if (closeParen == -1) throw new URISyntaxException(uri,
4867 "EXTRA missing trailing ')'", i);
4868
4869 while (i < closeParen) {
4870 // fetch the key value
4871 int j = uri.indexOf('=', i);
4872 if (j <= i + 1 || i >= closeParen) {
4873 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4874 }
4875 char type = uri.charAt(i);
4876 i++;
4877 String key = uri.substring(i, j);
4878 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004880 // get type-value
4881 j = uri.indexOf('!', i);
4882 if (j == -1 || j >= closeParen) j = closeParen;
4883 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4884 String value = uri.substring(i, j);
4885 i = j;
4886
4887 // create Bundle if it doesn't already exist
4888 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004889
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004890 // add item to bundle
4891 try {
4892 switch (type) {
4893 case 'S':
4894 intent.mExtras.putString(key, Uri.decode(value));
4895 break;
4896 case 'B':
4897 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4898 break;
4899 case 'b':
4900 intent.mExtras.putByte(key, Byte.parseByte(value));
4901 break;
4902 case 'c':
4903 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4904 break;
4905 case 'd':
4906 intent.mExtras.putDouble(key, Double.parseDouble(value));
4907 break;
4908 case 'f':
4909 intent.mExtras.putFloat(key, Float.parseFloat(value));
4910 break;
4911 case 'i':
4912 intent.mExtras.putInt(key, Integer.parseInt(value));
4913 break;
4914 case 'l':
4915 intent.mExtras.putLong(key, Long.parseLong(value));
4916 break;
4917 case 's':
4918 intent.mExtras.putShort(key, Short.parseShort(value));
4919 break;
4920 default:
4921 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4922 }
4923 } catch (NumberFormatException e) {
4924 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4925 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004926
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004927 char ch = uri.charAt(i);
4928 if (ch == ')') break;
4929 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4930 i++;
4931 }
4932 }
4933
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004934 if (isIntentFragment) {
4935 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4936 } else {
4937 intent.mData = Uri.parse(uri);
4938 }
Tom Taylord4a47292009-12-21 13:59:18 -08004939
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004940 if (intent.mAction == null) {
4941 // By default, if no action is specified, then use VIEW.
4942 intent.mAction = ACTION_VIEW;
4943 }
4944
4945 } else {
4946 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4947 }
4948
4949 return intent;
4950 }
4951
4952 /**
4953 * Retrieve the general action to be performed, such as
4954 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4955 * the information in the intent should be interpreted -- most importantly,
4956 * what to do with the data returned by {@link #getData}.
4957 *
4958 * @return The action of this intent or null if none is specified.
4959 *
4960 * @see #setAction
4961 */
4962 public String getAction() {
4963 return mAction;
4964 }
4965
4966 /**
4967 * Retrieve data this intent is operating on. This URI specifies the name
4968 * of the data; often it uses the content: scheme, specifying data in a
4969 * content provider. Other schemes may be handled by specific activities,
4970 * such as http: by the web browser.
4971 *
4972 * @return The URI of the data this intent is targeting or null.
4973 *
4974 * @see #getScheme
4975 * @see #setData
4976 */
4977 public Uri getData() {
4978 return mData;
4979 }
4980
4981 /**
4982 * The same as {@link #getData()}, but returns the URI as an encoded
4983 * String.
4984 */
4985 public String getDataString() {
4986 return mData != null ? mData.toString() : null;
4987 }
4988
4989 /**
4990 * Return the scheme portion of the intent's data. If the data is null or
4991 * does not include a scheme, null is returned. Otherwise, the scheme
4992 * prefix without the final ':' is returned, i.e. "http".
4993 *
4994 * <p>This is the same as calling getData().getScheme() (and checking for
4995 * null data).
4996 *
4997 * @return The scheme of this intent.
4998 *
4999 * @see #getData
5000 */
5001 public String getScheme() {
5002 return mData != null ? mData.getScheme() : null;
5003 }
5004
5005 /**
5006 * Retrieve any explicit MIME type included in the intent. This is usually
5007 * null, as the type is determined by the intent data.
5008 *
5009 * @return If a type was manually set, it is returned; else null is
5010 * returned.
5011 *
5012 * @see #resolveType(ContentResolver)
5013 * @see #setType
5014 */
5015 public String getType() {
5016 return mType;
5017 }
5018
5019 /**
5020 * Return the MIME data type of this intent. If the type field is
5021 * explicitly set, that is simply returned. Otherwise, if the data is set,
5022 * the type of that data is returned. If neither fields are set, a null is
5023 * returned.
5024 *
5025 * @return The MIME type of this intent.
5026 *
5027 * @see #getType
5028 * @see #resolveType(ContentResolver)
5029 */
5030 public String resolveType(Context context) {
5031 return resolveType(context.getContentResolver());
5032 }
5033
5034 /**
5035 * Return the MIME data type of this intent. If the type field is
5036 * explicitly set, that is simply returned. Otherwise, if the data is set,
5037 * the type of that data is returned. If neither fields are set, a null is
5038 * returned.
5039 *
5040 * @param resolver A ContentResolver that can be used to determine the MIME
5041 * type of the intent's data.
5042 *
5043 * @return The MIME type of this intent.
5044 *
5045 * @see #getType
5046 * @see #resolveType(Context)
5047 */
5048 public String resolveType(ContentResolver resolver) {
5049 if (mType != null) {
5050 return mType;
5051 }
5052 if (mData != null) {
5053 if ("content".equals(mData.getScheme())) {
5054 return resolver.getType(mData);
5055 }
5056 }
5057 return null;
5058 }
5059
5060 /**
5061 * Return the MIME data type of this intent, only if it will be needed for
5062 * intent resolution. This is not generally useful for application code;
5063 * it is used by the frameworks for communicating with back-end system
5064 * services.
5065 *
5066 * @param resolver A ContentResolver that can be used to determine the MIME
5067 * type of the intent's data.
5068 *
5069 * @return The MIME type of this intent, or null if it is unknown or not
5070 * needed.
5071 */
5072 public String resolveTypeIfNeeded(ContentResolver resolver) {
5073 if (mComponent != null) {
5074 return mType;
5075 }
5076 return resolveType(resolver);
5077 }
5078
5079 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005080 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081 *
5082 * @param category The category to check.
5083 *
5084 * @return boolean True if the intent contains the category, else false.
5085 *
5086 * @see #getCategories
5087 * @see #addCategory
5088 */
5089 public boolean hasCategory(String category) {
5090 return mCategories != null && mCategories.contains(category);
5091 }
5092
5093 /**
5094 * Return the set of all categories in the intent. If there are no categories,
5095 * returns NULL.
5096 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005097 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005098 *
5099 * @see #hasCategory
5100 * @see #addCategory
5101 */
5102 public Set<String> getCategories() {
5103 return mCategories;
5104 }
5105
5106 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005107 * Return the specific selector associated with this Intent. If there is
5108 * none, returns null. See {@link #setSelector} for more information.
5109 *
5110 * @see #setSelector
5111 */
5112 public Intent getSelector() {
5113 return mSelector;
5114 }
5115
5116 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005117 * Return the {@link ClipData} associated with this Intent. If there is
5118 * none, returns null. See {@link #setClipData} for more information.
5119 *
John Spurlock125d1332013-11-25 11:58:37 -05005120 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005121 */
5122 public ClipData getClipData() {
5123 return mClipData;
5124 }
5125
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005126 /** @hide */
5127 public int getContentUserHint() {
5128 return mContentUserHint;
5129 }
5130
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005131 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005132 * Sets the ClassLoader that will be used when unmarshalling
5133 * any Parcelable values from the extras of this Intent.
5134 *
5135 * @param loader a ClassLoader, or null to use the default loader
5136 * at the time of unmarshalling.
5137 */
5138 public void setExtrasClassLoader(ClassLoader loader) {
5139 if (mExtras != null) {
5140 mExtras.setClassLoader(loader);
5141 }
5142 }
5143
5144 /**
5145 * Returns true if an extra value is associated with the given name.
5146 * @param name the extra's name
5147 * @return true if the given extra is present.
5148 */
5149 public boolean hasExtra(String name) {
5150 return mExtras != null && mExtras.containsKey(name);
5151 }
5152
5153 /**
5154 * Returns true if the Intent's extras contain a parcelled file descriptor.
5155 * @return true if the Intent contains a parcelled file descriptor.
5156 */
5157 public boolean hasFileDescriptors() {
5158 return mExtras != null && mExtras.hasFileDescriptors();
5159 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005160
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04005161 /** @hide */
5162 public void setAllowFds(boolean allowFds) {
5163 if (mExtras != null) {
5164 mExtras.setAllowFds(allowFds);
5165 }
5166 }
5167
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005168 /**
5169 * Retrieve extended data from the intent.
5170 *
5171 * @param name The name of the desired item.
5172 *
5173 * @return the value of an item that previously added with putExtra()
5174 * or null if none was found.
5175 *
5176 * @deprecated
5177 * @hide
5178 */
5179 @Deprecated
5180 public Object getExtra(String name) {
5181 return getExtra(name, null);
5182 }
5183
5184 /**
5185 * Retrieve extended data from the intent.
5186 *
5187 * @param name The name of the desired item.
5188 * @param defaultValue the value to be returned if no value of the desired
5189 * type is stored with the given name.
5190 *
5191 * @return the value of an item that previously added with putExtra()
5192 * or the default value if none was found.
5193 *
5194 * @see #putExtra(String, boolean)
5195 */
5196 public boolean getBooleanExtra(String name, boolean defaultValue) {
5197 return mExtras == null ? defaultValue :
5198 mExtras.getBoolean(name, defaultValue);
5199 }
5200
5201 /**
5202 * Retrieve extended data from the intent.
5203 *
5204 * @param name The name of the desired item.
5205 * @param defaultValue the value to be returned if no value of the desired
5206 * type is stored with the given name.
5207 *
5208 * @return the value of an item that previously added with putExtra()
5209 * or the default value if none was found.
5210 *
5211 * @see #putExtra(String, byte)
5212 */
5213 public byte getByteExtra(String name, byte defaultValue) {
5214 return mExtras == null ? defaultValue :
5215 mExtras.getByte(name, defaultValue);
5216 }
5217
5218 /**
5219 * Retrieve extended data from the intent.
5220 *
5221 * @param name The name of the desired item.
5222 * @param defaultValue the value to be returned if no value of the desired
5223 * type is stored with the given name.
5224 *
5225 * @return the value of an item that previously added with putExtra()
5226 * or the default value if none was found.
5227 *
5228 * @see #putExtra(String, short)
5229 */
5230 public short getShortExtra(String name, short defaultValue) {
5231 return mExtras == null ? defaultValue :
5232 mExtras.getShort(name, defaultValue);
5233 }
5234
5235 /**
5236 * Retrieve extended data from the intent.
5237 *
5238 * @param name The name of the desired item.
5239 * @param defaultValue the value to be returned if no value of the desired
5240 * type is stored with the given name.
5241 *
5242 * @return the value of an item that previously added with putExtra()
5243 * or the default value if none was found.
5244 *
5245 * @see #putExtra(String, char)
5246 */
5247 public char getCharExtra(String name, char defaultValue) {
5248 return mExtras == null ? defaultValue :
5249 mExtras.getChar(name, defaultValue);
5250 }
5251
5252 /**
5253 * Retrieve extended data from the intent.
5254 *
5255 * @param name The name of the desired item.
5256 * @param defaultValue the value to be returned if no value of the desired
5257 * type is stored with the given name.
5258 *
5259 * @return the value of an item that previously added with putExtra()
5260 * or the default value if none was found.
5261 *
5262 * @see #putExtra(String, int)
5263 */
5264 public int getIntExtra(String name, int defaultValue) {
5265 return mExtras == null ? defaultValue :
5266 mExtras.getInt(name, defaultValue);
5267 }
5268
5269 /**
5270 * Retrieve extended data from the intent.
5271 *
5272 * @param name The name of the desired item.
5273 * @param defaultValue the value to be returned if no value of the desired
5274 * type is stored with the given name.
5275 *
5276 * @return the value of an item that previously added with putExtra()
5277 * or the default value if none was found.
5278 *
5279 * @see #putExtra(String, long)
5280 */
5281 public long getLongExtra(String name, long defaultValue) {
5282 return mExtras == null ? defaultValue :
5283 mExtras.getLong(name, defaultValue);
5284 }
5285
5286 /**
5287 * Retrieve extended data from the intent.
5288 *
5289 * @param name The name of the desired item.
5290 * @param defaultValue the value to be returned if no value of the desired
5291 * type is stored with the given name.
5292 *
5293 * @return the value of an item that previously added with putExtra(),
5294 * or the default value if no such item is present
5295 *
5296 * @see #putExtra(String, float)
5297 */
5298 public float getFloatExtra(String name, float defaultValue) {
5299 return mExtras == null ? defaultValue :
5300 mExtras.getFloat(name, defaultValue);
5301 }
5302
5303 /**
5304 * Retrieve extended data from the intent.
5305 *
5306 * @param name The name of the desired item.
5307 * @param defaultValue the value to be returned if no value of the desired
5308 * type is stored with the given name.
5309 *
5310 * @return the value of an item that previously added with putExtra()
5311 * or the default value if none was found.
5312 *
5313 * @see #putExtra(String, double)
5314 */
5315 public double getDoubleExtra(String name, double defaultValue) {
5316 return mExtras == null ? defaultValue :
5317 mExtras.getDouble(name, defaultValue);
5318 }
5319
5320 /**
5321 * Retrieve extended data from the intent.
5322 *
5323 * @param name The name of the desired item.
5324 *
5325 * @return the value of an item that previously added with putExtra()
5326 * or null if no String value was found.
5327 *
5328 * @see #putExtra(String, String)
5329 */
5330 public String getStringExtra(String name) {
5331 return mExtras == null ? null : mExtras.getString(name);
5332 }
5333
5334 /**
5335 * Retrieve extended data from the intent.
5336 *
5337 * @param name The name of the desired item.
5338 *
5339 * @return the value of an item that previously added with putExtra()
5340 * or null if no CharSequence value was found.
5341 *
5342 * @see #putExtra(String, CharSequence)
5343 */
5344 public CharSequence getCharSequenceExtra(String name) {
5345 return mExtras == null ? null : mExtras.getCharSequence(name);
5346 }
5347
5348 /**
5349 * Retrieve extended data from the intent.
5350 *
5351 * @param name The name of the desired item.
5352 *
5353 * @return the value of an item that previously added with putExtra()
5354 * or null if no Parcelable value was found.
5355 *
5356 * @see #putExtra(String, Parcelable)
5357 */
5358 public <T extends Parcelable> T getParcelableExtra(String name) {
5359 return mExtras == null ? null : mExtras.<T>getParcelable(name);
5360 }
5361
5362 /**
5363 * Retrieve extended data from the intent.
5364 *
5365 * @param name The name of the desired item.
5366 *
5367 * @return the value of an item that previously added with putExtra()
5368 * or null if no Parcelable[] value was found.
5369 *
5370 * @see #putExtra(String, Parcelable[])
5371 */
5372 public Parcelable[] getParcelableArrayExtra(String name) {
5373 return mExtras == null ? null : mExtras.getParcelableArray(name);
5374 }
5375
5376 /**
5377 * Retrieve extended data from the intent.
5378 *
5379 * @param name The name of the desired item.
5380 *
5381 * @return the value of an item that previously added with putExtra()
5382 * or null if no ArrayList<Parcelable> value was found.
5383 *
5384 * @see #putParcelableArrayListExtra(String, ArrayList)
5385 */
5386 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
5387 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
5388 }
5389
5390 /**
5391 * Retrieve extended data from the intent.
5392 *
5393 * @param name The name of the desired item.
5394 *
5395 * @return the value of an item that previously added with putExtra()
5396 * or null if no Serializable value was found.
5397 *
5398 * @see #putExtra(String, Serializable)
5399 */
5400 public Serializable getSerializableExtra(String name) {
5401 return mExtras == null ? null : mExtras.getSerializable(name);
5402 }
5403
5404 /**
5405 * Retrieve extended data from the intent.
5406 *
5407 * @param name The name of the desired item.
5408 *
5409 * @return the value of an item that previously added with putExtra()
5410 * or null if no ArrayList<Integer> value was found.
5411 *
5412 * @see #putIntegerArrayListExtra(String, ArrayList)
5413 */
5414 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
5415 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
5416 }
5417
5418 /**
5419 * Retrieve extended data from the intent.
5420 *
5421 * @param name The name of the desired item.
5422 *
5423 * @return the value of an item that previously added with putExtra()
5424 * or null if no ArrayList<String> value was found.
5425 *
5426 * @see #putStringArrayListExtra(String, ArrayList)
5427 */
5428 public ArrayList<String> getStringArrayListExtra(String name) {
5429 return mExtras == null ? null : mExtras.getStringArrayList(name);
5430 }
5431
5432 /**
5433 * Retrieve extended data from the intent.
5434 *
5435 * @param name The name of the desired item.
5436 *
5437 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005438 * or null if no ArrayList<CharSequence> value was found.
5439 *
5440 * @see #putCharSequenceArrayListExtra(String, ArrayList)
5441 */
5442 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
5443 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5444 }
5445
5446 /**
5447 * Retrieve extended data from the intent.
5448 *
5449 * @param name The name of the desired item.
5450 *
5451 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005452 * or null if no boolean array value was found.
5453 *
5454 * @see #putExtra(String, boolean[])
5455 */
5456 public boolean[] getBooleanArrayExtra(String name) {
5457 return mExtras == null ? null : mExtras.getBooleanArray(name);
5458 }
5459
5460 /**
5461 * Retrieve extended data from the intent.
5462 *
5463 * @param name The name of the desired item.
5464 *
5465 * @return the value of an item that previously added with putExtra()
5466 * or null if no byte array value was found.
5467 *
5468 * @see #putExtra(String, byte[])
5469 */
5470 public byte[] getByteArrayExtra(String name) {
5471 return mExtras == null ? null : mExtras.getByteArray(name);
5472 }
5473
5474 /**
5475 * Retrieve extended data from the intent.
5476 *
5477 * @param name The name of the desired item.
5478 *
5479 * @return the value of an item that previously added with putExtra()
5480 * or null if no short array value was found.
5481 *
5482 * @see #putExtra(String, short[])
5483 */
5484 public short[] getShortArrayExtra(String name) {
5485 return mExtras == null ? null : mExtras.getShortArray(name);
5486 }
5487
5488 /**
5489 * Retrieve extended data from the intent.
5490 *
5491 * @param name The name of the desired item.
5492 *
5493 * @return the value of an item that previously added with putExtra()
5494 * or null if no char array value was found.
5495 *
5496 * @see #putExtra(String, char[])
5497 */
5498 public char[] getCharArrayExtra(String name) {
5499 return mExtras == null ? null : mExtras.getCharArray(name);
5500 }
5501
5502 /**
5503 * Retrieve extended data from the intent.
5504 *
5505 * @param name The name of the desired item.
5506 *
5507 * @return the value of an item that previously added with putExtra()
5508 * or null if no int array value was found.
5509 *
5510 * @see #putExtra(String, int[])
5511 */
5512 public int[] getIntArrayExtra(String name) {
5513 return mExtras == null ? null : mExtras.getIntArray(name);
5514 }
5515
5516 /**
5517 * Retrieve extended data from the intent.
5518 *
5519 * @param name The name of the desired item.
5520 *
5521 * @return the value of an item that previously added with putExtra()
5522 * or null if no long array value was found.
5523 *
5524 * @see #putExtra(String, long[])
5525 */
5526 public long[] getLongArrayExtra(String name) {
5527 return mExtras == null ? null : mExtras.getLongArray(name);
5528 }
5529
5530 /**
5531 * Retrieve extended data from the intent.
5532 *
5533 * @param name The name of the desired item.
5534 *
5535 * @return the value of an item that previously added with putExtra()
5536 * or null if no float array value was found.
5537 *
5538 * @see #putExtra(String, float[])
5539 */
5540 public float[] getFloatArrayExtra(String name) {
5541 return mExtras == null ? null : mExtras.getFloatArray(name);
5542 }
5543
5544 /**
5545 * Retrieve extended data from the intent.
5546 *
5547 * @param name The name of the desired item.
5548 *
5549 * @return the value of an item that previously added with putExtra()
5550 * or null if no double array value was found.
5551 *
5552 * @see #putExtra(String, double[])
5553 */
5554 public double[] getDoubleArrayExtra(String name) {
5555 return mExtras == null ? null : mExtras.getDoubleArray(name);
5556 }
5557
5558 /**
5559 * Retrieve extended data from the intent.
5560 *
5561 * @param name The name of the desired item.
5562 *
5563 * @return the value of an item that previously added with putExtra()
5564 * or null if no String array value was found.
5565 *
5566 * @see #putExtra(String, String[])
5567 */
5568 public String[] getStringArrayExtra(String name) {
5569 return mExtras == null ? null : mExtras.getStringArray(name);
5570 }
5571
5572 /**
5573 * Retrieve extended data from the intent.
5574 *
5575 * @param name The name of the desired item.
5576 *
5577 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005578 * or null if no CharSequence array value was found.
5579 *
5580 * @see #putExtra(String, CharSequence[])
5581 */
5582 public CharSequence[] getCharSequenceArrayExtra(String name) {
5583 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5584 }
5585
5586 /**
5587 * Retrieve extended data from the intent.
5588 *
5589 * @param name The name of the desired item.
5590 *
5591 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005592 * or null if no Bundle value was found.
5593 *
5594 * @see #putExtra(String, Bundle)
5595 */
5596 public Bundle getBundleExtra(String name) {
5597 return mExtras == null ? null : mExtras.getBundle(name);
5598 }
5599
5600 /**
5601 * Retrieve extended data from the intent.
5602 *
5603 * @param name The name of the desired item.
5604 *
5605 * @return the value of an item that previously added with putExtra()
5606 * or null if no IBinder value was found.
5607 *
5608 * @see #putExtra(String, IBinder)
5609 *
5610 * @deprecated
5611 * @hide
5612 */
5613 @Deprecated
5614 public IBinder getIBinderExtra(String name) {
5615 return mExtras == null ? null : mExtras.getIBinder(name);
5616 }
5617
5618 /**
5619 * Retrieve extended data from the intent.
5620 *
5621 * @param name The name of the desired item.
5622 * @param defaultValue The default value to return in case no item is
5623 * associated with the key 'name'
5624 *
5625 * @return the value of an item that previously added with putExtra()
5626 * or defaultValue if none was found.
5627 *
5628 * @see #putExtra
5629 *
5630 * @deprecated
5631 * @hide
5632 */
5633 @Deprecated
5634 public Object getExtra(String name, Object defaultValue) {
5635 Object result = defaultValue;
5636 if (mExtras != null) {
5637 Object result2 = mExtras.get(name);
5638 if (result2 != null) {
5639 result = result2;
5640 }
5641 }
5642
5643 return result;
5644 }
5645
5646 /**
5647 * Retrieves a map of extended data from the intent.
5648 *
5649 * @return the map of all extras previously added with putExtra(),
5650 * or null if none have been added.
5651 */
5652 public Bundle getExtras() {
5653 return (mExtras != null)
5654 ? new Bundle(mExtras)
5655 : null;
5656 }
5657
5658 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07005659 * Filter extras to only basic types.
5660 * @hide
5661 */
5662 public void removeUnsafeExtras() {
5663 if (mExtras != null) {
5664 mExtras.filterValues();
5665 }
5666 }
5667
5668 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005669 * Retrieve any special flags associated with this intent. You will
5670 * normally just set them with {@link #setFlags} and let the system
5671 * take the appropriate action with them.
5672 *
5673 * @return int The currently set flags.
5674 *
5675 * @see #setFlags
5676 */
5677 public int getFlags() {
5678 return mFlags;
5679 }
5680
Dianne Hackborne7f97212011-02-24 14:40:20 -08005681 /** @hide */
5682 public boolean isExcludingStopped() {
5683 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5684 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5685 }
5686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005687 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005688 * Retrieve the application package name this Intent is limited to. When
5689 * resolving an Intent, if non-null this limits the resolution to only
5690 * components in the given application package.
5691 *
5692 * @return The name of the application package for the Intent.
5693 *
5694 * @see #resolveActivity
5695 * @see #setPackage
5696 */
5697 public String getPackage() {
5698 return mPackage;
5699 }
5700
5701 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005702 * Retrieve the concrete component associated with the intent. When receiving
5703 * an intent, this is the component that was found to best handle it (that is,
5704 * yourself) and will always be non-null; in all other cases it will be
5705 * null unless explicitly set.
5706 *
5707 * @return The name of the application component to handle the intent.
5708 *
5709 * @see #resolveActivity
5710 * @see #setComponent
5711 */
5712 public ComponentName getComponent() {
5713 return mComponent;
5714 }
5715
5716 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005717 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5718 * used as a hint to the receiver for animations and the like. Null means that there
5719 * is no source bounds.
5720 */
5721 public Rect getSourceBounds() {
5722 return mSourceBounds;
5723 }
5724
5725 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005726 * Return the Activity component that should be used to handle this intent.
5727 * The appropriate component is determined based on the information in the
5728 * intent, evaluated as follows:
5729 *
5730 * <p>If {@link #getComponent} returns an explicit class, that is returned
5731 * without any further consideration.
5732 *
5733 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5734 * category to be considered.
5735 *
5736 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5737 * action.
5738 *
5739 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5740 * this type.
5741 *
5742 * <p>If {@link #addCategory} has added any categories, the activity must
5743 * handle ALL of the categories specified.
5744 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005745 * <p>If {@link #getPackage} is non-NULL, only activity components in
5746 * that application package will be considered.
5747 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005748 * <p>If there are no activities that satisfy all of these conditions, a
5749 * null string is returned.
5750 *
5751 * <p>If multiple activities are found to satisfy the intent, the one with
5752 * the highest priority will be used. If there are multiple activities
5753 * with the same priority, the system will either pick the best activity
5754 * based on user preference, or resolve to a system class that will allow
5755 * the user to pick an activity and forward from there.
5756 *
5757 * <p>This method is implemented simply by calling
5758 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5759 * true.</p>
5760 * <p> This API is called for you as part of starting an activity from an
5761 * intent. You do not normally need to call it yourself.</p>
5762 *
5763 * @param pm The package manager with which to resolve the Intent.
5764 *
5765 * @return Name of the component implementing an activity that can
5766 * display the intent.
5767 *
5768 * @see #setComponent
5769 * @see #getComponent
5770 * @see #resolveActivityInfo
5771 */
5772 public ComponentName resolveActivity(PackageManager pm) {
5773 if (mComponent != null) {
5774 return mComponent;
5775 }
5776
5777 ResolveInfo info = pm.resolveActivity(
5778 this, PackageManager.MATCH_DEFAULT_ONLY);
5779 if (info != null) {
5780 return new ComponentName(
5781 info.activityInfo.applicationInfo.packageName,
5782 info.activityInfo.name);
5783 }
5784
5785 return null;
5786 }
5787
5788 /**
5789 * Resolve the Intent into an {@link ActivityInfo}
5790 * describing the activity that should execute the intent. Resolution
5791 * follows the same rules as described for {@link #resolveActivity}, but
5792 * you get back the completely information about the resolved activity
5793 * instead of just its class name.
5794 *
5795 * @param pm The package manager with which to resolve the Intent.
5796 * @param flags Addition information to retrieve as per
5797 * {@link PackageManager#getActivityInfo(ComponentName, int)
5798 * PackageManager.getActivityInfo()}.
5799 *
5800 * @return PackageManager.ActivityInfo
5801 *
5802 * @see #resolveActivity
5803 */
5804 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5805 ActivityInfo ai = null;
5806 if (mComponent != null) {
5807 try {
5808 ai = pm.getActivityInfo(mComponent, flags);
5809 } catch (PackageManager.NameNotFoundException e) {
5810 // ignore
5811 }
5812 } else {
5813 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005814 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005815 if (info != null) {
5816 ai = info.activityInfo;
5817 }
5818 }
5819
5820 return ai;
5821 }
5822
5823 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005824 * Special function for use by the system to resolve service
5825 * intents to system apps. Throws an exception if there are
5826 * multiple potential matches to the Intent. Returns null if
5827 * there are no matches.
5828 * @hide
5829 */
5830 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5831 if (mComponent != null) {
5832 return mComponent;
5833 }
5834
5835 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5836 if (results == null) {
5837 return null;
5838 }
5839 ComponentName comp = null;
5840 for (int i=0; i<results.size(); i++) {
5841 ResolveInfo ri = results.get(i);
5842 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5843 continue;
5844 }
5845 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5846 ri.serviceInfo.name);
5847 if (comp != null) {
5848 throw new IllegalStateException("Multiple system services handle " + this
5849 + ": " + comp + ", " + foundComp);
5850 }
5851 comp = foundComp;
5852 }
5853 return comp;
5854 }
5855
5856 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005857 * Set the general action to be performed.
5858 *
5859 * @param action An action name, such as ACTION_VIEW. Application-specific
5860 * actions should be prefixed with the vendor's package name.
5861 *
5862 * @return Returns the same Intent object, for chaining multiple calls
5863 * into a single statement.
5864 *
5865 * @see #getAction
5866 */
5867 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005868 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005869 return this;
5870 }
5871
5872 /**
5873 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005874 * clears any type that was previously set by {@link #setType} or
5875 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005876 *
Nick Pellyccae4122012-01-09 14:12:58 -08005877 * <p><em>Note: scheme matching in the Android framework is
5878 * case-sensitive, unlike the formal RFC. As a result,
5879 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005880 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005881 * {@link #setDataAndNormalize}
5882 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005883 *
Nick Pellyccae4122012-01-09 14:12:58 -08005884 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005885 *
5886 * @return Returns the same Intent object, for chaining multiple calls
5887 * into a single statement.
5888 *
5889 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005890 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005891 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005892 */
5893 public Intent setData(Uri data) {
5894 mData = data;
5895 mType = null;
5896 return this;
5897 }
5898
5899 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005900 * Normalize and set the data this intent is operating on.
5901 *
5902 * <p>This method automatically clears any type that was
5903 * previously set (for example, by {@link #setType}).
5904 *
5905 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005906 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005907 * so really this is just a convenience method for
5908 * <pre>
5909 * setData(data.normalize())
5910 * </pre>
5911 *
5912 * @param data The Uri of the data this intent is now targeting.
5913 *
5914 * @return Returns the same Intent object, for chaining multiple calls
5915 * into a single statement.
5916 *
5917 * @see #getData
5918 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005919 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005920 */
5921 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005922 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005923 }
5924
5925 /**
5926 * Set an explicit MIME data type.
5927 *
5928 * <p>This is used to create intents that only specify a type and not data,
5929 * for example to indicate the type of data to return.
5930 *
5931 * <p>This method automatically clears any data that was
5932 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005933 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005934 * <p><em>Note: MIME type matching in the Android framework is
5935 * case-sensitive, unlike formal RFC MIME types. As a result,
5936 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005937 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5938 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005939 *
5940 * @param type The MIME type of the data being handled by this intent.
5941 *
5942 * @return Returns the same Intent object, for chaining multiple calls
5943 * into a single statement.
5944 *
5945 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005946 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005947 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005948 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005949 */
5950 public Intent setType(String type) {
5951 mData = null;
5952 mType = type;
5953 return this;
5954 }
5955
5956 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005957 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005958 *
Nick Pellyccae4122012-01-09 14:12:58 -08005959 * <p>This is used to create intents that only specify a type and not data,
5960 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005961 *
Nick Pellyccae4122012-01-09 14:12:58 -08005962 * <p>This method automatically clears any data that was
5963 * previously set (for example by {@link #setData}).
5964 *
5965 * <p>The MIME type is normalized using
5966 * {@link #normalizeMimeType} before it is set,
5967 * so really this is just a convenience method for
5968 * <pre>
5969 * setType(Intent.normalizeMimeType(type))
5970 * </pre>
5971 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005972 * @param type The MIME type of the data being handled by this intent.
5973 *
5974 * @return Returns the same Intent object, for chaining multiple calls
5975 * into a single statement.
5976 *
Nick Pellyccae4122012-01-09 14:12:58 -08005977 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005978 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005979 * @see #normalizeMimeType
5980 */
5981 public Intent setTypeAndNormalize(String type) {
5982 return setType(normalizeMimeType(type));
5983 }
5984
5985 /**
5986 * (Usually optional) Set the data for the intent along with an explicit
5987 * MIME data type. This method should very rarely be used -- it allows you
5988 * to override the MIME type that would ordinarily be inferred from the
5989 * data with your own type given here.
5990 *
5991 * <p><em>Note: MIME type and Uri scheme matching in the
5992 * Android framework is case-sensitive, unlike the formal RFC definitions.
5993 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005994 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005995 * {@link #setDataAndTypeAndNormalize}
5996 * to ensure that they are converted to lower case.</em>
5997 *
5998 * @param data The Uri of the data this intent is now targeting.
5999 * @param type The MIME type of the data being handled by this intent.
6000 *
6001 * @return Returns the same Intent object, for chaining multiple calls
6002 * into a single statement.
6003 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006004 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006005 * @see #setData
6006 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006007 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006008 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006009 */
6010 public Intent setDataAndType(Uri data, String type) {
6011 mData = data;
6012 mType = type;
6013 return this;
6014 }
6015
6016 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006017 * (Usually optional) Normalize and set both the data Uri and an explicit
6018 * MIME data type. This method should very rarely be used -- it allows you
6019 * to override the MIME type that would ordinarily be inferred from the
6020 * data with your own type given here.
6021 *
6022 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006023 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006024 * before they are set, so really this is just a convenience method for
6025 * <pre>
6026 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6027 * </pre>
6028 *
6029 * @param data The Uri of the data this intent is now targeting.
6030 * @param type The MIME type of the data being handled by this intent.
6031 *
6032 * @return Returns the same Intent object, for chaining multiple calls
6033 * into a single statement.
6034 *
6035 * @see #setType
6036 * @see #setData
6037 * @see #setDataAndType
6038 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006039 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006040 */
6041 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006042 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006043 }
6044
6045 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006046 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006047 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006048 * activities that provide <em>all</em> of the requested categories will be
6049 * used.
6050 *
6051 * @param category The desired category. This can be either one of the
6052 * predefined Intent categories, or a custom category in your own
6053 * namespace.
6054 *
6055 * @return Returns the same Intent object, for chaining multiple calls
6056 * into a single statement.
6057 *
6058 * @see #hasCategory
6059 * @see #removeCategory
6060 */
6061 public Intent addCategory(String category) {
6062 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006063 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006064 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006065 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006066 return this;
6067 }
6068
6069 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006070 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006071 *
6072 * @param category The category to remove.
6073 *
6074 * @see #addCategory
6075 */
6076 public void removeCategory(String category) {
6077 if (mCategories != null) {
6078 mCategories.remove(category);
6079 if (mCategories.size() == 0) {
6080 mCategories = null;
6081 }
6082 }
6083 }
6084
6085 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006086 * Set a selector for this Intent. This is a modification to the kinds of
6087 * things the Intent will match. If the selector is set, it will be used
6088 * when trying to find entities that can handle the Intent, instead of the
6089 * main contents of the Intent. This allows you build an Intent containing
6090 * a generic protocol while targeting it more specifically.
6091 *
6092 * <p>An example of where this may be used is with things like
6093 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6094 * Intent that will launch the Browser application. However, the correct
6095 * main entry point of an application is actually {@link #ACTION_MAIN}
6096 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6097 * used to specify the actual Activity to launch. If you launch the browser
6098 * with something different, undesired behavior may happen if the user has
6099 * previously or later launches it the normal way, since they do not match.
6100 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6101 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6102 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6103 *
6104 * <p>Setting a selector does not impact the behavior of
6105 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6106 * desired behavior of a selector -- it does not impact the base meaning
6107 * of the Intent, just what kinds of things will be matched against it
6108 * when determining who can handle it.</p>
6109 *
6110 * <p>You can not use both a selector and {@link #setPackage(String)} on
6111 * the same base Intent.</p>
6112 *
6113 * @param selector The desired selector Intent; set to null to not use
6114 * a special selector.
6115 */
6116 public void setSelector(Intent selector) {
6117 if (selector == this) {
6118 throw new IllegalArgumentException(
6119 "Intent being set as a selector of itself");
6120 }
6121 if (selector != null && mPackage != null) {
6122 throw new IllegalArgumentException(
6123 "Can't set selector when package name is already set");
6124 }
6125 mSelector = selector;
6126 }
6127
6128 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006129 * Set a {@link ClipData} associated with this Intent. This replaces any
6130 * previously set ClipData.
6131 *
6132 * <p>The ClipData in an intent is not used for Intent matching or other
6133 * such operations. Semantically it is like extras, used to transmit
6134 * additional data with the Intent. The main feature of using this over
6135 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
6136 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
6137 * items included in the clip data. This is useful, in particular, if
6138 * you want to transmit an Intent containing multiple <code>content:</code>
6139 * URIs for which the recipient may not have global permission to access the
6140 * content provider.
6141 *
6142 * <p>If the ClipData contains items that are themselves Intents, any
6143 * grant flags in those Intents will be ignored. Only the top-level flags
6144 * of the main Intent are respected, and will be applied to all Uri or
6145 * Intent items in the clip (or sub-items of the clip).
6146 *
6147 * <p>The MIME type, label, and icon in the ClipData object are not
6148 * directly used by Intent. Applications should generally rely on the
6149 * MIME type of the Intent itself, not what it may find in the ClipData.
6150 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05006151 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006152 *
6153 * @param clip The new clip to set. May be null to clear the current clip.
6154 */
6155 public void setClipData(ClipData clip) {
6156 mClipData = clip;
6157 }
6158
6159 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006160 * This is NOT a secure mechanism to identify the user who sent the intent.
6161 * When the intent is sent to a different user, it is used to fix uris by adding the userId
6162 * who sent the intent.
6163 * @hide
6164 */
6165 public void setContentUserHint(int contentUserHint) {
6166 mContentUserHint = contentUserHint;
6167 }
6168
6169 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006170 * Add extended data to the intent. The name must include a package
6171 * prefix, for example the app com.android.contacts would use names
6172 * like "com.android.contacts.ShowAll".
6173 *
6174 * @param name The name of the extra data, with package prefix.
6175 * @param value The boolean data value.
6176 *
6177 * @return Returns the same Intent object, for chaining multiple calls
6178 * into a single statement.
6179 *
6180 * @see #putExtras
6181 * @see #removeExtra
6182 * @see #getBooleanExtra(String, boolean)
6183 */
6184 public Intent putExtra(String name, boolean value) {
6185 if (mExtras == null) {
6186 mExtras = new Bundle();
6187 }
6188 mExtras.putBoolean(name, value);
6189 return this;
6190 }
6191
6192 /**
6193 * Add extended data to the intent. The name must include a package
6194 * prefix, for example the app com.android.contacts would use names
6195 * like "com.android.contacts.ShowAll".
6196 *
6197 * @param name The name of the extra data, with package prefix.
6198 * @param value The byte data value.
6199 *
6200 * @return Returns the same Intent object, for chaining multiple calls
6201 * into a single statement.
6202 *
6203 * @see #putExtras
6204 * @see #removeExtra
6205 * @see #getByteExtra(String, byte)
6206 */
6207 public Intent putExtra(String name, byte value) {
6208 if (mExtras == null) {
6209 mExtras = new Bundle();
6210 }
6211 mExtras.putByte(name, value);
6212 return this;
6213 }
6214
6215 /**
6216 * Add extended data to the intent. The name must include a package
6217 * prefix, for example the app com.android.contacts would use names
6218 * like "com.android.contacts.ShowAll".
6219 *
6220 * @param name The name of the extra data, with package prefix.
6221 * @param value The char data value.
6222 *
6223 * @return Returns the same Intent object, for chaining multiple calls
6224 * into a single statement.
6225 *
6226 * @see #putExtras
6227 * @see #removeExtra
6228 * @see #getCharExtra(String, char)
6229 */
6230 public Intent putExtra(String name, char value) {
6231 if (mExtras == null) {
6232 mExtras = new Bundle();
6233 }
6234 mExtras.putChar(name, value);
6235 return this;
6236 }
6237
6238 /**
6239 * Add extended data to the intent. The name must include a package
6240 * prefix, for example the app com.android.contacts would use names
6241 * like "com.android.contacts.ShowAll".
6242 *
6243 * @param name The name of the extra data, with package prefix.
6244 * @param value The short data value.
6245 *
6246 * @return Returns the same Intent object, for chaining multiple calls
6247 * into a single statement.
6248 *
6249 * @see #putExtras
6250 * @see #removeExtra
6251 * @see #getShortExtra(String, short)
6252 */
6253 public Intent putExtra(String name, short value) {
6254 if (mExtras == null) {
6255 mExtras = new Bundle();
6256 }
6257 mExtras.putShort(name, value);
6258 return this;
6259 }
6260
6261 /**
6262 * Add extended data to the intent. The name must include a package
6263 * prefix, for example the app com.android.contacts would use names
6264 * like "com.android.contacts.ShowAll".
6265 *
6266 * @param name The name of the extra data, with package prefix.
6267 * @param value The integer data value.
6268 *
6269 * @return Returns the same Intent object, for chaining multiple calls
6270 * into a single statement.
6271 *
6272 * @see #putExtras
6273 * @see #removeExtra
6274 * @see #getIntExtra(String, int)
6275 */
6276 public Intent putExtra(String name, int value) {
6277 if (mExtras == null) {
6278 mExtras = new Bundle();
6279 }
6280 mExtras.putInt(name, value);
6281 return this;
6282 }
6283
6284 /**
6285 * Add extended data to the intent. The name must include a package
6286 * prefix, for example the app com.android.contacts would use names
6287 * like "com.android.contacts.ShowAll".
6288 *
6289 * @param name The name of the extra data, with package prefix.
6290 * @param value The long data value.
6291 *
6292 * @return Returns the same Intent object, for chaining multiple calls
6293 * into a single statement.
6294 *
6295 * @see #putExtras
6296 * @see #removeExtra
6297 * @see #getLongExtra(String, long)
6298 */
6299 public Intent putExtra(String name, long value) {
6300 if (mExtras == null) {
6301 mExtras = new Bundle();
6302 }
6303 mExtras.putLong(name, value);
6304 return this;
6305 }
6306
6307 /**
6308 * Add extended data to the intent. The name must include a package
6309 * prefix, for example the app com.android.contacts would use names
6310 * like "com.android.contacts.ShowAll".
6311 *
6312 * @param name The name of the extra data, with package prefix.
6313 * @param value The float data value.
6314 *
6315 * @return Returns the same Intent object, for chaining multiple calls
6316 * into a single statement.
6317 *
6318 * @see #putExtras
6319 * @see #removeExtra
6320 * @see #getFloatExtra(String, float)
6321 */
6322 public Intent putExtra(String name, float value) {
6323 if (mExtras == null) {
6324 mExtras = new Bundle();
6325 }
6326 mExtras.putFloat(name, value);
6327 return this;
6328 }
6329
6330 /**
6331 * Add extended data to the intent. The name must include a package
6332 * prefix, for example the app com.android.contacts would use names
6333 * like "com.android.contacts.ShowAll".
6334 *
6335 * @param name The name of the extra data, with package prefix.
6336 * @param value The double data value.
6337 *
6338 * @return Returns the same Intent object, for chaining multiple calls
6339 * into a single statement.
6340 *
6341 * @see #putExtras
6342 * @see #removeExtra
6343 * @see #getDoubleExtra(String, double)
6344 */
6345 public Intent putExtra(String name, double value) {
6346 if (mExtras == null) {
6347 mExtras = new Bundle();
6348 }
6349 mExtras.putDouble(name, value);
6350 return this;
6351 }
6352
6353 /**
6354 * Add extended data to the intent. The name must include a package
6355 * prefix, for example the app com.android.contacts would use names
6356 * like "com.android.contacts.ShowAll".
6357 *
6358 * @param name The name of the extra data, with package prefix.
6359 * @param value The String data value.
6360 *
6361 * @return Returns the same Intent object, for chaining multiple calls
6362 * into a single statement.
6363 *
6364 * @see #putExtras
6365 * @see #removeExtra
6366 * @see #getStringExtra(String)
6367 */
6368 public Intent putExtra(String name, String value) {
6369 if (mExtras == null) {
6370 mExtras = new Bundle();
6371 }
6372 mExtras.putString(name, value);
6373 return this;
6374 }
6375
6376 /**
6377 * Add extended data to the intent. The name must include a package
6378 * prefix, for example the app com.android.contacts would use names
6379 * like "com.android.contacts.ShowAll".
6380 *
6381 * @param name The name of the extra data, with package prefix.
6382 * @param value The CharSequence data value.
6383 *
6384 * @return Returns the same Intent object, for chaining multiple calls
6385 * into a single statement.
6386 *
6387 * @see #putExtras
6388 * @see #removeExtra
6389 * @see #getCharSequenceExtra(String)
6390 */
6391 public Intent putExtra(String name, CharSequence value) {
6392 if (mExtras == null) {
6393 mExtras = new Bundle();
6394 }
6395 mExtras.putCharSequence(name, value);
6396 return this;
6397 }
6398
6399 /**
6400 * Add extended data to the intent. The name must include a package
6401 * prefix, for example the app com.android.contacts would use names
6402 * like "com.android.contacts.ShowAll".
6403 *
6404 * @param name The name of the extra data, with package prefix.
6405 * @param value The Parcelable data value.
6406 *
6407 * @return Returns the same Intent object, for chaining multiple calls
6408 * into a single statement.
6409 *
6410 * @see #putExtras
6411 * @see #removeExtra
6412 * @see #getParcelableExtra(String)
6413 */
6414 public Intent putExtra(String name, Parcelable value) {
6415 if (mExtras == null) {
6416 mExtras = new Bundle();
6417 }
6418 mExtras.putParcelable(name, value);
6419 return this;
6420 }
6421
6422 /**
6423 * Add extended data to the intent. The name must include a package
6424 * prefix, for example the app com.android.contacts would use names
6425 * like "com.android.contacts.ShowAll".
6426 *
6427 * @param name The name of the extra data, with package prefix.
6428 * @param value The Parcelable[] data value.
6429 *
6430 * @return Returns the same Intent object, for chaining multiple calls
6431 * into a single statement.
6432 *
6433 * @see #putExtras
6434 * @see #removeExtra
6435 * @see #getParcelableArrayExtra(String)
6436 */
6437 public Intent putExtra(String name, Parcelable[] value) {
6438 if (mExtras == null) {
6439 mExtras = new Bundle();
6440 }
6441 mExtras.putParcelableArray(name, value);
6442 return this;
6443 }
6444
6445 /**
6446 * Add extended data to the intent. The name must include a package
6447 * prefix, for example the app com.android.contacts would use names
6448 * like "com.android.contacts.ShowAll".
6449 *
6450 * @param name The name of the extra data, with package prefix.
6451 * @param value The ArrayList<Parcelable> data value.
6452 *
6453 * @return Returns the same Intent object, for chaining multiple calls
6454 * into a single statement.
6455 *
6456 * @see #putExtras
6457 * @see #removeExtra
6458 * @see #getParcelableArrayListExtra(String)
6459 */
6460 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6461 if (mExtras == null) {
6462 mExtras = new Bundle();
6463 }
6464 mExtras.putParcelableArrayList(name, value);
6465 return this;
6466 }
6467
6468 /**
6469 * Add extended data to the intent. The name must include a package
6470 * prefix, for example the app com.android.contacts would use names
6471 * like "com.android.contacts.ShowAll".
6472 *
6473 * @param name The name of the extra data, with package prefix.
6474 * @param value The ArrayList<Integer> data value.
6475 *
6476 * @return Returns the same Intent object, for chaining multiple calls
6477 * into a single statement.
6478 *
6479 * @see #putExtras
6480 * @see #removeExtra
6481 * @see #getIntegerArrayListExtra(String)
6482 */
6483 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6484 if (mExtras == null) {
6485 mExtras = new Bundle();
6486 }
6487 mExtras.putIntegerArrayList(name, value);
6488 return this;
6489 }
6490
6491 /**
6492 * Add extended data to the intent. The name must include a package
6493 * prefix, for example the app com.android.contacts would use names
6494 * like "com.android.contacts.ShowAll".
6495 *
6496 * @param name The name of the extra data, with package prefix.
6497 * @param value The ArrayList<String> data value.
6498 *
6499 * @return Returns the same Intent object, for chaining multiple calls
6500 * into a single statement.
6501 *
6502 * @see #putExtras
6503 * @see #removeExtra
6504 * @see #getStringArrayListExtra(String)
6505 */
6506 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6507 if (mExtras == null) {
6508 mExtras = new Bundle();
6509 }
6510 mExtras.putStringArrayList(name, value);
6511 return this;
6512 }
6513
6514 /**
6515 * Add extended data to the intent. The name must include a package
6516 * prefix, for example the app com.android.contacts would use names
6517 * like "com.android.contacts.ShowAll".
6518 *
6519 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006520 * @param value The ArrayList<CharSequence> data value.
6521 *
6522 * @return Returns the same Intent object, for chaining multiple calls
6523 * into a single statement.
6524 *
6525 * @see #putExtras
6526 * @see #removeExtra
6527 * @see #getCharSequenceArrayListExtra(String)
6528 */
6529 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6530 if (mExtras == null) {
6531 mExtras = new Bundle();
6532 }
6533 mExtras.putCharSequenceArrayList(name, value);
6534 return this;
6535 }
6536
6537 /**
6538 * Add extended data to the intent. The name must include a package
6539 * prefix, for example the app com.android.contacts would use names
6540 * like "com.android.contacts.ShowAll".
6541 *
6542 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006543 * @param value The Serializable data value.
6544 *
6545 * @return Returns the same Intent object, for chaining multiple calls
6546 * into a single statement.
6547 *
6548 * @see #putExtras
6549 * @see #removeExtra
6550 * @see #getSerializableExtra(String)
6551 */
6552 public Intent putExtra(String name, Serializable value) {
6553 if (mExtras == null) {
6554 mExtras = new Bundle();
6555 }
6556 mExtras.putSerializable(name, value);
6557 return this;
6558 }
6559
6560 /**
6561 * Add extended data to the intent. The name must include a package
6562 * prefix, for example the app com.android.contacts would use names
6563 * like "com.android.contacts.ShowAll".
6564 *
6565 * @param name The name of the extra data, with package prefix.
6566 * @param value The boolean array data value.
6567 *
6568 * @return Returns the same Intent object, for chaining multiple calls
6569 * into a single statement.
6570 *
6571 * @see #putExtras
6572 * @see #removeExtra
6573 * @see #getBooleanArrayExtra(String)
6574 */
6575 public Intent putExtra(String name, boolean[] value) {
6576 if (mExtras == null) {
6577 mExtras = new Bundle();
6578 }
6579 mExtras.putBooleanArray(name, value);
6580 return this;
6581 }
6582
6583 /**
6584 * Add extended data to the intent. The name must include a package
6585 * prefix, for example the app com.android.contacts would use names
6586 * like "com.android.contacts.ShowAll".
6587 *
6588 * @param name The name of the extra data, with package prefix.
6589 * @param value The byte array data value.
6590 *
6591 * @return Returns the same Intent object, for chaining multiple calls
6592 * into a single statement.
6593 *
6594 * @see #putExtras
6595 * @see #removeExtra
6596 * @see #getByteArrayExtra(String)
6597 */
6598 public Intent putExtra(String name, byte[] value) {
6599 if (mExtras == null) {
6600 mExtras = new Bundle();
6601 }
6602 mExtras.putByteArray(name, value);
6603 return this;
6604 }
6605
6606 /**
6607 * Add extended data to the intent. The name must include a package
6608 * prefix, for example the app com.android.contacts would use names
6609 * like "com.android.contacts.ShowAll".
6610 *
6611 * @param name The name of the extra data, with package prefix.
6612 * @param value The short array data value.
6613 *
6614 * @return Returns the same Intent object, for chaining multiple calls
6615 * into a single statement.
6616 *
6617 * @see #putExtras
6618 * @see #removeExtra
6619 * @see #getShortArrayExtra(String)
6620 */
6621 public Intent putExtra(String name, short[] value) {
6622 if (mExtras == null) {
6623 mExtras = new Bundle();
6624 }
6625 mExtras.putShortArray(name, value);
6626 return this;
6627 }
6628
6629 /**
6630 * Add extended data to the intent. The name must include a package
6631 * prefix, for example the app com.android.contacts would use names
6632 * like "com.android.contacts.ShowAll".
6633 *
6634 * @param name The name of the extra data, with package prefix.
6635 * @param value The char array data value.
6636 *
6637 * @return Returns the same Intent object, for chaining multiple calls
6638 * into a single statement.
6639 *
6640 * @see #putExtras
6641 * @see #removeExtra
6642 * @see #getCharArrayExtra(String)
6643 */
6644 public Intent putExtra(String name, char[] value) {
6645 if (mExtras == null) {
6646 mExtras = new Bundle();
6647 }
6648 mExtras.putCharArray(name, value);
6649 return this;
6650 }
6651
6652 /**
6653 * Add extended data to the intent. The name must include a package
6654 * prefix, for example the app com.android.contacts would use names
6655 * like "com.android.contacts.ShowAll".
6656 *
6657 * @param name The name of the extra data, with package prefix.
6658 * @param value The int array data value.
6659 *
6660 * @return Returns the same Intent object, for chaining multiple calls
6661 * into a single statement.
6662 *
6663 * @see #putExtras
6664 * @see #removeExtra
6665 * @see #getIntArrayExtra(String)
6666 */
6667 public Intent putExtra(String name, int[] value) {
6668 if (mExtras == null) {
6669 mExtras = new Bundle();
6670 }
6671 mExtras.putIntArray(name, value);
6672 return this;
6673 }
6674
6675 /**
6676 * Add extended data to the intent. The name must include a package
6677 * prefix, for example the app com.android.contacts would use names
6678 * like "com.android.contacts.ShowAll".
6679 *
6680 * @param name The name of the extra data, with package prefix.
6681 * @param value The byte array data value.
6682 *
6683 * @return Returns the same Intent object, for chaining multiple calls
6684 * into a single statement.
6685 *
6686 * @see #putExtras
6687 * @see #removeExtra
6688 * @see #getLongArrayExtra(String)
6689 */
6690 public Intent putExtra(String name, long[] value) {
6691 if (mExtras == null) {
6692 mExtras = new Bundle();
6693 }
6694 mExtras.putLongArray(name, value);
6695 return this;
6696 }
6697
6698 /**
6699 * Add extended data to the intent. The name must include a package
6700 * prefix, for example the app com.android.contacts would use names
6701 * like "com.android.contacts.ShowAll".
6702 *
6703 * @param name The name of the extra data, with package prefix.
6704 * @param value The float array data value.
6705 *
6706 * @return Returns the same Intent object, for chaining multiple calls
6707 * into a single statement.
6708 *
6709 * @see #putExtras
6710 * @see #removeExtra
6711 * @see #getFloatArrayExtra(String)
6712 */
6713 public Intent putExtra(String name, float[] value) {
6714 if (mExtras == null) {
6715 mExtras = new Bundle();
6716 }
6717 mExtras.putFloatArray(name, value);
6718 return this;
6719 }
6720
6721 /**
6722 * Add extended data to the intent. The name must include a package
6723 * prefix, for example the app com.android.contacts would use names
6724 * like "com.android.contacts.ShowAll".
6725 *
6726 * @param name The name of the extra data, with package prefix.
6727 * @param value The double array data value.
6728 *
6729 * @return Returns the same Intent object, for chaining multiple calls
6730 * into a single statement.
6731 *
6732 * @see #putExtras
6733 * @see #removeExtra
6734 * @see #getDoubleArrayExtra(String)
6735 */
6736 public Intent putExtra(String name, double[] value) {
6737 if (mExtras == null) {
6738 mExtras = new Bundle();
6739 }
6740 mExtras.putDoubleArray(name, value);
6741 return this;
6742 }
6743
6744 /**
6745 * Add extended data to the intent. The name must include a package
6746 * prefix, for example the app com.android.contacts would use names
6747 * like "com.android.contacts.ShowAll".
6748 *
6749 * @param name The name of the extra data, with package prefix.
6750 * @param value The String array data value.
6751 *
6752 * @return Returns the same Intent object, for chaining multiple calls
6753 * into a single statement.
6754 *
6755 * @see #putExtras
6756 * @see #removeExtra
6757 * @see #getStringArrayExtra(String)
6758 */
6759 public Intent putExtra(String name, String[] value) {
6760 if (mExtras == null) {
6761 mExtras = new Bundle();
6762 }
6763 mExtras.putStringArray(name, value);
6764 return this;
6765 }
6766
6767 /**
6768 * Add extended data to the intent. The name must include a package
6769 * prefix, for example the app com.android.contacts would use names
6770 * like "com.android.contacts.ShowAll".
6771 *
6772 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006773 * @param value The CharSequence array data value.
6774 *
6775 * @return Returns the same Intent object, for chaining multiple calls
6776 * into a single statement.
6777 *
6778 * @see #putExtras
6779 * @see #removeExtra
6780 * @see #getCharSequenceArrayExtra(String)
6781 */
6782 public Intent putExtra(String name, CharSequence[] value) {
6783 if (mExtras == null) {
6784 mExtras = new Bundle();
6785 }
6786 mExtras.putCharSequenceArray(name, value);
6787 return this;
6788 }
6789
6790 /**
6791 * Add extended data to the intent. The name must include a package
6792 * prefix, for example the app com.android.contacts would use names
6793 * like "com.android.contacts.ShowAll".
6794 *
6795 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006796 * @param value The Bundle data value.
6797 *
6798 * @return Returns the same Intent object, for chaining multiple calls
6799 * into a single statement.
6800 *
6801 * @see #putExtras
6802 * @see #removeExtra
6803 * @see #getBundleExtra(String)
6804 */
6805 public Intent putExtra(String name, Bundle value) {
6806 if (mExtras == null) {
6807 mExtras = new Bundle();
6808 }
6809 mExtras.putBundle(name, value);
6810 return this;
6811 }
6812
6813 /**
6814 * Add extended data to the intent. The name must include a package
6815 * prefix, for example the app com.android.contacts would use names
6816 * like "com.android.contacts.ShowAll".
6817 *
6818 * @param name The name of the extra data, with package prefix.
6819 * @param value The IBinder data value.
6820 *
6821 * @return Returns the same Intent object, for chaining multiple calls
6822 * into a single statement.
6823 *
6824 * @see #putExtras
6825 * @see #removeExtra
6826 * @see #getIBinderExtra(String)
6827 *
6828 * @deprecated
6829 * @hide
6830 */
6831 @Deprecated
6832 public Intent putExtra(String name, IBinder value) {
6833 if (mExtras == null) {
6834 mExtras = new Bundle();
6835 }
6836 mExtras.putIBinder(name, value);
6837 return this;
6838 }
6839
6840 /**
6841 * Copy all extras in 'src' in to this intent.
6842 *
6843 * @param src Contains the extras to copy.
6844 *
6845 * @see #putExtra
6846 */
6847 public Intent putExtras(Intent src) {
6848 if (src.mExtras != null) {
6849 if (mExtras == null) {
6850 mExtras = new Bundle(src.mExtras);
6851 } else {
6852 mExtras.putAll(src.mExtras);
6853 }
6854 }
6855 return this;
6856 }
6857
6858 /**
6859 * Add a set of extended data to the intent. The keys must include a package
6860 * prefix, for example the app com.android.contacts would use names
6861 * like "com.android.contacts.ShowAll".
6862 *
6863 * @param extras The Bundle of extras to add to this intent.
6864 *
6865 * @see #putExtra
6866 * @see #removeExtra
6867 */
6868 public Intent putExtras(Bundle extras) {
6869 if (mExtras == null) {
6870 mExtras = new Bundle();
6871 }
6872 mExtras.putAll(extras);
6873 return this;
6874 }
6875
6876 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006877 * Completely replace the extras in the Intent with the extras in the
6878 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006879 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006880 * @param src The exact extras contained in this Intent are copied
6881 * into the target intent, replacing any that were previously there.
6882 */
6883 public Intent replaceExtras(Intent src) {
6884 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6885 return this;
6886 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006887
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006888 /**
6889 * Completely replace the extras in the Intent with the given Bundle of
6890 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006891 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006892 * @param extras The new set of extras in the Intent, or null to erase
6893 * all extras.
6894 */
6895 public Intent replaceExtras(Bundle extras) {
6896 mExtras = extras != null ? new Bundle(extras) : null;
6897 return this;
6898 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006899
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006900 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006901 * Remove extended data from the intent.
6902 *
6903 * @see #putExtra
6904 */
6905 public void removeExtra(String name) {
6906 if (mExtras != null) {
6907 mExtras.remove(name);
6908 if (mExtras.size() == 0) {
6909 mExtras = null;
6910 }
6911 }
6912 }
6913
6914 /**
6915 * Set special flags controlling how this intent is handled. Most values
6916 * here depend on the type of component being executed by the Intent,
6917 * specifically the FLAG_ACTIVITY_* flags are all for use with
6918 * {@link Context#startActivity Context.startActivity()} and the
6919 * FLAG_RECEIVER_* flags are all for use with
6920 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6921 *
Scott Main7aee61f2011-02-08 11:25:01 -08006922 * <p>See the
6923 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6924 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006925 * the behavior of your application.
6926 *
6927 * @param flags The desired flags.
6928 *
6929 * @return Returns the same Intent object, for chaining multiple calls
6930 * into a single statement.
6931 *
6932 * @see #getFlags
6933 * @see #addFlags
6934 *
6935 * @see #FLAG_GRANT_READ_URI_PERMISSION
6936 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006937 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6938 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006939 * @see #FLAG_DEBUG_LOG_RESOLUTION
6940 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006941 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006942 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006943 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006944 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006945 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6946 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006947 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006948 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006949 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006950 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006951 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006952 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006953 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006954 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6955 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006956 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006957 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006958 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006959 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6960 */
6961 public Intent setFlags(int flags) {
6962 mFlags = flags;
6963 return this;
6964 }
6965
6966 /**
6967 * Add additional flags to the intent (or with existing flags
6968 * value).
6969 *
6970 * @param flags The new flags to set.
6971 *
6972 * @return Returns the same Intent object, for chaining multiple calls
6973 * into a single statement.
6974 *
6975 * @see #setFlags
6976 */
6977 public Intent addFlags(int flags) {
6978 mFlags |= flags;
6979 return this;
6980 }
6981
6982 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006983 * (Usually optional) Set an explicit application package name that limits
6984 * the components this Intent will resolve to. If left to the default
6985 * value of null, all components in all applications will considered.
6986 * If non-null, the Intent can only match the components in the given
6987 * application package.
6988 *
6989 * @param packageName The name of the application package to handle the
6990 * intent, or null to allow any application package.
6991 *
6992 * @return Returns the same Intent object, for chaining multiple calls
6993 * into a single statement.
6994 *
6995 * @see #getPackage
6996 * @see #resolveActivity
6997 */
6998 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006999 if (packageName != null && mSelector != null) {
7000 throw new IllegalArgumentException(
7001 "Can't set package name when selector is already set");
7002 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007003 mPackage = packageName;
7004 return this;
7005 }
7006
7007 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007008 * (Usually optional) Explicitly set the component to handle the intent.
7009 * If left with the default value of null, the system will determine the
7010 * appropriate class to use based on the other fields (action, data,
7011 * type, categories) in the Intent. If this class is defined, the
7012 * specified class will always be used regardless of the other fields. You
7013 * should only set this value when you know you absolutely want a specific
7014 * class to be used; otherwise it is better to let the system find the
7015 * appropriate class so that you will respect the installed applications
7016 * and user preferences.
7017 *
7018 * @param component The name of the application component to handle the
7019 * intent, or null to let the system find one for you.
7020 *
7021 * @return Returns the same Intent object, for chaining multiple calls
7022 * into a single statement.
7023 *
7024 * @see #setClass
7025 * @see #setClassName(Context, String)
7026 * @see #setClassName(String, String)
7027 * @see #getComponent
7028 * @see #resolveActivity
7029 */
7030 public Intent setComponent(ComponentName component) {
7031 mComponent = component;
7032 return this;
7033 }
7034
7035 /**
7036 * Convenience for calling {@link #setComponent} with an
7037 * explicit class name.
7038 *
7039 * @param packageContext A Context of the application package implementing
7040 * this class.
7041 * @param className The name of a class inside of the application package
7042 * that will be used as the component for this Intent.
7043 *
7044 * @return Returns the same Intent object, for chaining multiple calls
7045 * into a single statement.
7046 *
7047 * @see #setComponent
7048 * @see #setClass
7049 */
7050 public Intent setClassName(Context packageContext, String className) {
7051 mComponent = new ComponentName(packageContext, className);
7052 return this;
7053 }
7054
7055 /**
7056 * Convenience for calling {@link #setComponent} with an
7057 * explicit application package name and class name.
7058 *
7059 * @param packageName The name of the package implementing the desired
7060 * component.
7061 * @param className The name of a class inside of the application package
7062 * that will be used as the component for this Intent.
7063 *
7064 * @return Returns the same Intent object, for chaining multiple calls
7065 * into a single statement.
7066 *
7067 * @see #setComponent
7068 * @see #setClass
7069 */
7070 public Intent setClassName(String packageName, String className) {
7071 mComponent = new ComponentName(packageName, className);
7072 return this;
7073 }
7074
7075 /**
7076 * Convenience for calling {@link #setComponent(ComponentName)} with the
7077 * name returned by a {@link Class} object.
7078 *
7079 * @param packageContext A Context of the application package implementing
7080 * this class.
7081 * @param cls The class name to set, equivalent to
7082 * <code>setClassName(context, cls.getName())</code>.
7083 *
7084 * @return Returns the same Intent object, for chaining multiple calls
7085 * into a single statement.
7086 *
7087 * @see #setComponent
7088 */
7089 public Intent setClass(Context packageContext, Class<?> cls) {
7090 mComponent = new ComponentName(packageContext, cls);
7091 return this;
7092 }
7093
7094 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007095 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7096 * used as a hint to the receiver for animations and the like. Null means that there
7097 * is no source bounds.
7098 */
7099 public void setSourceBounds(Rect r) {
7100 if (r != null) {
7101 mSourceBounds = new Rect(r);
7102 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007103 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007104 }
7105 }
7106
Tor Norbyed9273d62013-05-30 15:59:53 -07007107 /** @hide */
7108 @IntDef(flag = true,
7109 value = {
7110 FILL_IN_ACTION,
7111 FILL_IN_DATA,
7112 FILL_IN_CATEGORIES,
7113 FILL_IN_COMPONENT,
7114 FILL_IN_PACKAGE,
7115 FILL_IN_SOURCE_BOUNDS,
7116 FILL_IN_SELECTOR,
7117 FILL_IN_CLIP_DATA
7118 })
7119 @Retention(RetentionPolicy.SOURCE)
7120 public @interface FillInFlags {}
7121
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007122 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007123 * Use with {@link #fillIn} to allow the current action value to be
7124 * overwritten, even if it is already set.
7125 */
7126 public static final int FILL_IN_ACTION = 1<<0;
7127
7128 /**
7129 * Use with {@link #fillIn} to allow the current data or type value
7130 * overwritten, even if it is already set.
7131 */
7132 public static final int FILL_IN_DATA = 1<<1;
7133
7134 /**
7135 * Use with {@link #fillIn} to allow the current categories to be
7136 * overwritten, even if they are already set.
7137 */
7138 public static final int FILL_IN_CATEGORIES = 1<<2;
7139
7140 /**
7141 * Use with {@link #fillIn} to allow the current component value to be
7142 * overwritten, even if it is already set.
7143 */
7144 public static final int FILL_IN_COMPONENT = 1<<3;
7145
7146 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007147 * Use with {@link #fillIn} to allow the current package value to be
7148 * overwritten, even if it is already set.
7149 */
7150 public static final int FILL_IN_PACKAGE = 1<<4;
7151
7152 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007153 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007154 * overwritten, even if it is already set.
7155 */
7156 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
7157
7158 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007159 * Use with {@link #fillIn} to allow the current selector to be
7160 * overwritten, even if it is already set.
7161 */
7162 public static final int FILL_IN_SELECTOR = 1<<6;
7163
7164 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007165 * Use with {@link #fillIn} to allow the current ClipData to be
7166 * overwritten, even if it is already set.
7167 */
7168 public static final int FILL_IN_CLIP_DATA = 1<<7;
7169
7170 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007171 * Copy the contents of <var>other</var> in to this object, but only
7172 * where fields are not defined by this object. For purposes of a field
7173 * being defined, the following pieces of data in the Intent are
7174 * considered to be separate fields:
7175 *
7176 * <ul>
7177 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08007178 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007179 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
7180 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007181 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007182 * <li> component, as set by {@link #setComponent(ComponentName)} or
7183 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007184 * <li> source bounds, as set by {@link #setSourceBounds}.
7185 * <li> selector, as set by {@link #setSelector(Intent)}.
7186 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007187 * <li> each top-level name in the associated extras.
7188 * </ul>
7189 *
7190 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007191 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007192 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7193 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
7194 * the restriction where the corresponding field will not be replaced if
7195 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007196 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007197 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
7198 * is explicitly specified. The selector will only be copied if
7199 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07007200 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007201 * <p>For example, consider Intent A with {data="foo", categories="bar"}
7202 * and Intent B with {action="gotit", data-type="some/thing",
7203 * categories="one","two"}.
7204 *
7205 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
7206 * containing: {action="gotit", data-type="some/thing",
7207 * categories="bar"}.
7208 *
7209 * @param other Another Intent whose values are to be used to fill in
7210 * the current one.
7211 * @param flags Options to control which fields can be filled in.
7212 *
7213 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007214 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07007215 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7216 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
7217 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007218 */
Tor Norbyed9273d62013-05-30 15:59:53 -07007219 @FillInFlags
7220 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007221 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007222 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007223 if (other.mAction != null
7224 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007225 mAction = other.mAction;
7226 changes |= FILL_IN_ACTION;
7227 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007228 if ((other.mData != null || other.mType != null)
7229 && ((mData == null && mType == null)
7230 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007231 mData = other.mData;
7232 mType = other.mType;
7233 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007234 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007235 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007236 if (other.mCategories != null
7237 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007238 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007239 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007240 }
7241 changes |= FILL_IN_CATEGORIES;
7242 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007243 if (other.mPackage != null
7244 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007245 // Only do this if mSelector is not set.
7246 if (mSelector == null) {
7247 mPackage = other.mPackage;
7248 changes |= FILL_IN_PACKAGE;
7249 }
7250 }
7251 // Selector is special: it can only be set if explicitly allowed,
7252 // for the same reason as the component name.
7253 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
7254 if (mPackage == null) {
7255 mSelector = new Intent(other.mSelector);
7256 mPackage = null;
7257 changes |= FILL_IN_SELECTOR;
7258 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007259 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007260 if (other.mClipData != null
7261 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
7262 mClipData = other.mClipData;
7263 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007264 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007265 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007266 // Component is special: it can -only- be set if explicitly allowed,
7267 // since otherwise the sender could force the intent somewhere the
7268 // originator didn't intend.
7269 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007270 mComponent = other.mComponent;
7271 changes |= FILL_IN_COMPONENT;
7272 }
7273 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007274 if (other.mSourceBounds != null
7275 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
7276 mSourceBounds = new Rect(other.mSourceBounds);
7277 changes |= FILL_IN_SOURCE_BOUNDS;
7278 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007279 if (mExtras == null) {
7280 if (other.mExtras != null) {
7281 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007282 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007283 }
7284 } else if (other.mExtras != null) {
7285 try {
7286 Bundle newb = new Bundle(other.mExtras);
7287 newb.putAll(mExtras);
7288 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007289 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007290 } catch (RuntimeException e) {
7291 // Modifying the extras can cause us to unparcel the contents
7292 // of the bundle, and if we do this in the system process that
7293 // may fail. We really should handle this (i.e., the Bundle
7294 // impl shouldn't be on top of a plain map), but for now just
7295 // ignore it and keep the original contents. :(
7296 Log.w("Intent", "Failure filling in extras", e);
7297 }
7298 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007299 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
7300 && other.mContentUserHint != UserHandle.USER_CURRENT) {
7301 mContentUserHint = other.mContentUserHint;
7302 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007303 return changes;
7304 }
7305
7306 /**
7307 * Wrapper class holding an Intent and implementing comparisons on it for
7308 * the purpose of filtering. The class implements its
7309 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
7310 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
7311 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
7312 * on the wrapped Intent.
7313 */
7314 public static final class FilterComparison {
7315 private final Intent mIntent;
7316 private final int mHashCode;
7317
7318 public FilterComparison(Intent intent) {
7319 mIntent = intent;
7320 mHashCode = intent.filterHashCode();
7321 }
7322
7323 /**
7324 * Return the Intent that this FilterComparison represents.
7325 * @return Returns the Intent held by the FilterComparison. Do
7326 * not modify!
7327 */
7328 public Intent getIntent() {
7329 return mIntent;
7330 }
7331
7332 @Override
7333 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007334 if (obj instanceof FilterComparison) {
7335 Intent other = ((FilterComparison)obj).mIntent;
7336 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007337 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007338 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007339 }
7340
7341 @Override
7342 public int hashCode() {
7343 return mHashCode;
7344 }
7345 }
7346
7347 /**
7348 * Determine if two intents are the same for the purposes of intent
7349 * resolution (filtering). That is, if their action, data, type,
7350 * class, and categories are the same. This does <em>not</em> compare
7351 * any extra data included in the intents.
7352 *
7353 * @param other The other Intent to compare against.
7354 *
7355 * @return Returns true if action, data, type, class, and categories
7356 * are the same.
7357 */
7358 public boolean filterEquals(Intent other) {
7359 if (other == null) {
7360 return false;
7361 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07007362 if (!Objects.equals(this.mAction, other.mAction)) return false;
7363 if (!Objects.equals(this.mData, other.mData)) return false;
7364 if (!Objects.equals(this.mType, other.mType)) return false;
7365 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
7366 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
7367 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007368
7369 return true;
7370 }
7371
7372 /**
7373 * Generate hash code that matches semantics of filterEquals().
7374 *
7375 * @return Returns the hash value of the action, data, type, class, and
7376 * categories.
7377 *
7378 * @see #filterEquals
7379 */
7380 public int filterHashCode() {
7381 int code = 0;
7382 if (mAction != null) {
7383 code += mAction.hashCode();
7384 }
7385 if (mData != null) {
7386 code += mData.hashCode();
7387 }
7388 if (mType != null) {
7389 code += mType.hashCode();
7390 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007391 if (mPackage != null) {
7392 code += mPackage.hashCode();
7393 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007394 if (mComponent != null) {
7395 code += mComponent.hashCode();
7396 }
7397 if (mCategories != null) {
7398 code += mCategories.hashCode();
7399 }
7400 return code;
7401 }
7402
7403 @Override
7404 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007405 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007406
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007407 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007408 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007409 b.append(" }");
7410
7411 return b.toString();
7412 }
7413
7414 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007415 public String toInsecureString() {
7416 StringBuilder b = new StringBuilder(128);
7417
7418 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007419 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007420 b.append(" }");
7421
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007422 return b.toString();
7423 }
Romain Guy4969af72009-06-17 10:53:19 -07007424
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007425 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007426 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007427 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007428
7429 b.append("Intent { ");
7430 toShortString(b, false, true, true, true);
7431 b.append(" }");
7432
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007433 return b.toString();
7434 }
7435
7436 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007437 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
7438 StringBuilder b = new StringBuilder(128);
7439 toShortString(b, secure, comp, extras, clip);
7440 return b.toString();
7441 }
7442
7443 /** @hide */
7444 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
7445 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007446 boolean first = true;
7447 if (mAction != null) {
7448 b.append("act=").append(mAction);
7449 first = false;
7450 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007451 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007452 if (!first) {
7453 b.append(' ');
7454 }
7455 first = false;
7456 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007457 for (int i=0; i<mCategories.size(); i++) {
7458 if (i > 0) b.append(',');
7459 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007460 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007461 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007462 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007463 if (mData != null) {
7464 if (!first) {
7465 b.append(' ');
7466 }
7467 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007468 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007469 if (secure) {
7470 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007471 } else {
7472 b.append(mData);
7473 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007474 }
7475 if (mType != null) {
7476 if (!first) {
7477 b.append(' ');
7478 }
7479 first = false;
7480 b.append("typ=").append(mType);
7481 }
7482 if (mFlags != 0) {
7483 if (!first) {
7484 b.append(' ');
7485 }
7486 first = false;
7487 b.append("flg=0x").append(Integer.toHexString(mFlags));
7488 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007489 if (mPackage != null) {
7490 if (!first) {
7491 b.append(' ');
7492 }
7493 first = false;
7494 b.append("pkg=").append(mPackage);
7495 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007496 if (comp && mComponent != null) {
7497 if (!first) {
7498 b.append(' ');
7499 }
7500 first = false;
7501 b.append("cmp=").append(mComponent.flattenToShortString());
7502 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007503 if (mSourceBounds != null) {
7504 if (!first) {
7505 b.append(' ');
7506 }
7507 first = false;
7508 b.append("bnds=").append(mSourceBounds.toShortString());
7509 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007510 if (mClipData != null) {
7511 if (!first) {
7512 b.append(' ');
7513 }
7514 first = false;
7515 if (clip) {
7516 b.append("clip={");
7517 mClipData.toShortString(b);
7518 b.append('}');
7519 } else {
7520 b.append("(has clip)");
7521 }
7522 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007523 if (extras && mExtras != null) {
7524 if (!first) {
7525 b.append(' ');
7526 }
7527 first = false;
7528 b.append("(has extras)");
7529 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007530 if (mContentUserHint != UserHandle.USER_CURRENT) {
7531 if (!first) {
7532 b.append(' ');
7533 }
7534 first = false;
7535 b.append("u=").append(mContentUserHint);
7536 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007537 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007538 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007539 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007540 b.append("}");
7541 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007542 }
7543
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007544 /**
7545 * Call {@link #toUri} with 0 flags.
7546 * @deprecated Use {@link #toUri} instead.
7547 */
7548 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007549 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007550 return toUri(0);
7551 }
7552
7553 /**
7554 * Convert this Intent into a String holding a URI representation of it.
7555 * The returned URI string has been properly URI encoded, so it can be
7556 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7557 * Intent's data as the base URI, with an additional fragment describing
7558 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007559 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007560 * <p>You can convert the returned string back to an Intent with
7561 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007562 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007563 * @param flags Additional operating flags. Either 0,
7564 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007565 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007566 * @return Returns a URI encoding URI string describing the entire contents
7567 * of the Intent.
7568 */
7569 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007570 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007571 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
7572 if (mPackage == null) {
7573 throw new IllegalArgumentException(
7574 "Intent must include an explicit package name to build an android-app: "
7575 + this);
7576 }
7577 uri.append("android-app://");
7578 uri.append(mPackage);
7579 String scheme = null;
7580 if (mData != null) {
7581 scheme = mData.getScheme();
7582 if (scheme != null) {
7583 uri.append('/');
7584 uri.append(scheme);
7585 String authority = mData.getEncodedAuthority();
7586 if (authority != null) {
7587 uri.append('/');
7588 uri.append(authority);
7589 String path = mData.getEncodedPath();
7590 if (path != null) {
7591 uri.append(path);
7592 }
7593 String queryParams = mData.getEncodedQuery();
7594 if (queryParams != null) {
7595 uri.append('?');
7596 uri.append(queryParams);
7597 }
7598 String fragment = mData.getEncodedFragment();
7599 if (fragment != null) {
7600 uri.append('#');
7601 uri.append(fragment);
7602 }
7603 }
7604 }
7605 }
7606 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
7607 mPackage, flags);
7608 return uri.toString();
7609 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007610 String scheme = null;
7611 if (mData != null) {
7612 String data = mData.toString();
7613 if ((flags&URI_INTENT_SCHEME) != 0) {
7614 final int N = data.length();
7615 for (int i=0; i<N; i++) {
7616 char c = data.charAt(i);
7617 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7618 || c == '.' || c == '-') {
7619 continue;
7620 }
7621 if (c == ':' && i > 0) {
7622 // Valid scheme.
7623 scheme = data.substring(0, i);
7624 uri.append("intent:");
7625 data = data.substring(i+1);
7626 break;
7627 }
Tom Taylord4a47292009-12-21 13:59:18 -08007628
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007629 // No scheme.
7630 break;
7631 }
7632 }
7633 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007634
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007635 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7636 uri.append("intent:");
7637 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007638
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007639 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007640
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007641 return uri.toString();
7642 }
7643
7644 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
7645 String defPackage, int flags) {
7646 StringBuilder frag = new StringBuilder(128);
7647
7648 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007649 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08007650 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007651 // Note that for now we are not going to try to handle the
7652 // data part; not clear how to represent this as a URI, and
7653 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007654 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
7655 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007656 }
7657
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007658 if (frag.length() > 0) {
7659 uri.append("#Intent;");
7660 uri.append(frag);
7661 uri.append("end");
7662 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007663 }
7664
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007665 private void toUriInner(StringBuilder uri, String scheme, String defAction,
7666 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007667 if (scheme != null) {
7668 uri.append("scheme=").append(scheme).append(';');
7669 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007670 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007671 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007672 }
7673 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007674 for (int i=0; i<mCategories.size(); i++) {
7675 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007676 }
7677 }
7678 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007679 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007680 }
7681 if (mFlags != 0) {
7682 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7683 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007684 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007685 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7686 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007687 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007688 uri.append("component=").append(Uri.encode(
7689 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007690 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007691 if (mSourceBounds != null) {
7692 uri.append("sourceBounds=")
7693 .append(Uri.encode(mSourceBounds.flattenToString()))
7694 .append(';');
7695 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007696 if (mExtras != null) {
7697 for (String key : mExtras.keySet()) {
7698 final Object value = mExtras.get(key);
7699 char entryType =
7700 value instanceof String ? 'S' :
7701 value instanceof Boolean ? 'B' :
7702 value instanceof Byte ? 'b' :
7703 value instanceof Character ? 'c' :
7704 value instanceof Double ? 'd' :
7705 value instanceof Float ? 'f' :
7706 value instanceof Integer ? 'i' :
7707 value instanceof Long ? 'l' :
7708 value instanceof Short ? 's' :
7709 '\0';
7710
7711 if (entryType != '\0') {
7712 uri.append(entryType);
7713 uri.append('.');
7714 uri.append(Uri.encode(key));
7715 uri.append('=');
7716 uri.append(Uri.encode(value.toString()));
7717 uri.append(';');
7718 }
7719 }
7720 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007721 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007722
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007723 public int describeContents() {
7724 return (mExtras != null) ? mExtras.describeContents() : 0;
7725 }
7726
7727 public void writeToParcel(Parcel out, int flags) {
7728 out.writeString(mAction);
7729 Uri.writeToParcel(out, mData);
7730 out.writeString(mType);
7731 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007732 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007733 ComponentName.writeToParcel(mComponent, out);
7734
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007735 if (mSourceBounds != null) {
7736 out.writeInt(1);
7737 mSourceBounds.writeToParcel(out, flags);
7738 } else {
7739 out.writeInt(0);
7740 }
7741
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007742 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007743 final int N = mCategories.size();
7744 out.writeInt(N);
7745 for (int i=0; i<N; i++) {
7746 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007747 }
7748 } else {
7749 out.writeInt(0);
7750 }
7751
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007752 if (mSelector != null) {
7753 out.writeInt(1);
7754 mSelector.writeToParcel(out, flags);
7755 } else {
7756 out.writeInt(0);
7757 }
7758
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007759 if (mClipData != null) {
7760 out.writeInt(1);
7761 mClipData.writeToParcel(out, flags);
7762 } else {
7763 out.writeInt(0);
7764 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007765 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007766 out.writeBundle(mExtras);
7767 }
7768
7769 public static final Parcelable.Creator<Intent> CREATOR
7770 = new Parcelable.Creator<Intent>() {
7771 public Intent createFromParcel(Parcel in) {
7772 return new Intent(in);
7773 }
7774 public Intent[] newArray(int size) {
7775 return new Intent[size];
7776 }
7777 };
7778
Dianne Hackborneb034652009-09-07 00:49:58 -07007779 /** @hide */
7780 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007781 readFromParcel(in);
7782 }
7783
7784 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007785 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007786 mData = Uri.CREATOR.createFromParcel(in);
7787 mType = in.readString();
7788 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007789 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007790 mComponent = ComponentName.readFromParcel(in);
7791
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007792 if (in.readInt() != 0) {
7793 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7794 }
7795
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007796 int N = in.readInt();
7797 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007798 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007799 int i;
7800 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007801 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007802 }
7803 } else {
7804 mCategories = null;
7805 }
7806
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007807 if (in.readInt() != 0) {
7808 mSelector = new Intent(in);
7809 }
7810
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007811 if (in.readInt() != 0) {
7812 mClipData = new ClipData(in);
7813 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007814 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007815 mExtras = in.readBundle();
7816 }
7817
7818 /**
7819 * Parses the "intent" element (and its children) from XML and instantiates
7820 * an Intent object. The given XML parser should be located at the tag
7821 * where parsing should start (often named "intent"), from which the
7822 * basic action, data, type, and package and class name will be
7823 * retrieved. The function will then parse in to any child elements,
7824 * looking for <category android:name="xxx"> tags to add categories and
7825 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7826 * to the intent.
7827 *
7828 * @param resources The Resources to use when inflating resources.
7829 * @param parser The XML parser pointing at an "intent" tag.
7830 * @param attrs The AttributeSet interface for retrieving extended
7831 * attribute data at the current <var>parser</var> location.
7832 * @return An Intent object matching the XML data.
7833 * @throws XmlPullParserException If there was an XML parsing error.
7834 * @throws IOException If there was an I/O error.
7835 */
7836 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7837 throws XmlPullParserException, IOException {
7838 Intent intent = new Intent();
7839
7840 TypedArray sa = resources.obtainAttributes(attrs,
7841 com.android.internal.R.styleable.Intent);
7842
7843 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7844
7845 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7846 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7847 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7848
7849 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7850 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7851 if (packageName != null && className != null) {
7852 intent.setComponent(new ComponentName(packageName, className));
7853 }
7854
7855 sa.recycle();
7856
7857 int outerDepth = parser.getDepth();
7858 int type;
7859 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7860 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7861 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7862 continue;
7863 }
7864
7865 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007866 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007867 sa = resources.obtainAttributes(attrs,
7868 com.android.internal.R.styleable.IntentCategory);
7869 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7870 sa.recycle();
7871
7872 if (cat != null) {
7873 intent.addCategory(cat);
7874 }
7875 XmlUtils.skipCurrentTag(parser);
7876
Craig Mautner21d24a22014-04-23 11:45:37 -07007877 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007878 if (intent.mExtras == null) {
7879 intent.mExtras = new Bundle();
7880 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007881 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007882 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007883
7884 } else {
7885 XmlUtils.skipCurrentTag(parser);
7886 }
7887 }
7888
7889 return intent;
7890 }
Nick Pellyccae4122012-01-09 14:12:58 -08007891
Craig Mautner21d24a22014-04-23 11:45:37 -07007892 /** @hide */
7893 public void saveToXml(XmlSerializer out) throws IOException {
7894 if (mAction != null) {
7895 out.attribute(null, ATTR_ACTION, mAction);
7896 }
7897 if (mData != null) {
7898 out.attribute(null, ATTR_DATA, mData.toString());
7899 }
7900 if (mType != null) {
7901 out.attribute(null, ATTR_TYPE, mType);
7902 }
7903 if (mComponent != null) {
7904 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7905 }
7906 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7907
7908 if (mCategories != null) {
7909 out.startTag(null, TAG_CATEGORIES);
7910 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7911 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7912 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007913 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007914 }
7915 }
7916
7917 /** @hide */
7918 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7919 XmlPullParserException {
7920 Intent intent = new Intent();
7921 final int outerDepth = in.getDepth();
7922
7923 int attrCount = in.getAttributeCount();
7924 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7925 final String attrName = in.getAttributeName(attrNdx);
7926 final String attrValue = in.getAttributeValue(attrNdx);
7927 if (ATTR_ACTION.equals(attrName)) {
7928 intent.setAction(attrValue);
7929 } else if (ATTR_DATA.equals(attrName)) {
7930 intent.setData(Uri.parse(attrValue));
7931 } else if (ATTR_TYPE.equals(attrName)) {
7932 intent.setType(attrValue);
7933 } else if (ATTR_COMPONENT.equals(attrName)) {
7934 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7935 } else if (ATTR_FLAGS.equals(attrName)) {
7936 intent.setFlags(Integer.valueOf(attrValue, 16));
7937 } else {
7938 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7939 }
7940 }
7941
7942 int event;
7943 String name;
7944 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7945 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7946 if (event == XmlPullParser.START_TAG) {
7947 name = in.getName();
7948 if (TAG_CATEGORIES.equals(name)) {
7949 attrCount = in.getAttributeCount();
7950 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7951 intent.addCategory(in.getAttributeValue(attrNdx));
7952 }
7953 } else {
7954 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7955 XmlUtils.skipCurrentTag(in);
7956 }
7957 }
7958 }
7959
7960 return intent;
7961 }
7962
Nick Pellyccae4122012-01-09 14:12:58 -08007963 /**
7964 * Normalize a MIME data type.
7965 *
7966 * <p>A normalized MIME type has white-space trimmed,
7967 * content-type parameters removed, and is lower-case.
7968 * This aligns the type with Android best practices for
7969 * intent filtering.
7970 *
7971 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7972 * "text/x-vCard" becomes "text/x-vcard".
7973 *
7974 * <p>All MIME types received from outside Android (such as user input,
7975 * or external sources like Bluetooth, NFC, or the Internet) should
7976 * be normalized before they are used to create an Intent.
7977 *
7978 * @param type MIME data type to normalize
7979 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007980 * @see #setType
7981 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007982 */
7983 public static String normalizeMimeType(String type) {
7984 if (type == null) {
7985 return null;
7986 }
7987
Elliott Hughescb64d432013-08-02 10:00:44 -07007988 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007989
7990 final int semicolonIndex = type.indexOf(';');
7991 if (semicolonIndex != -1) {
7992 type = type.substring(0, semicolonIndex);
7993 }
7994 return type;
7995 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007996
7997 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007998 * Prepare this {@link Intent} to leave an app process.
7999 *
8000 * @hide
8001 */
8002 public void prepareToLeaveProcess() {
8003 setAllowFds(false);
8004
8005 if (mSelector != null) {
8006 mSelector.prepareToLeaveProcess();
8007 }
8008 if (mClipData != null) {
8009 mClipData.prepareToLeaveProcess();
8010 }
8011
8012 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8013 // There are several ACTION_MEDIA_* broadcasts that send file://
8014 // Uris, so only check common actions.
8015 if (ACTION_VIEW.equals(mAction) ||
8016 ACTION_EDIT.equals(mAction) ||
8017 ACTION_ATTACH_DATA.equals(mAction)) {
8018 mData.checkFileUriExposed("Intent.getData()");
8019 }
8020 }
8021 }
8022
8023 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008024 * @hide
8025 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008026 public void prepareToEnterProcess() {
8027 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008028 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8029 fixUris(mContentUserHint);
8030 mContentUserHint = UserHandle.USER_CURRENT;
8031 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008032 }
8033 }
8034
8035 /**
8036 * @hide
8037 */
8038 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008039 Uri data = getData();
8040 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008041 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008042 }
8043 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008044 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008045 }
8046 String action = getAction();
8047 if (ACTION_SEND.equals(action)) {
8048 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8049 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008050 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008051 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008052 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008053 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8054 if (streams != null) {
8055 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8056 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008057 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008058 }
8059 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8060 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008061 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8062 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8063 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8064 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8065 if (output != null) {
8066 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8067 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008068 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008069 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008070
8071 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008072 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008073 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8074 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008075 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008076 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008077 * @hide
8078 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008079 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008080 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008081 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008082
8083 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008084 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008085
8086 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008087 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008088 // Inspect contained intents to see if we need to migrate extras. We
8089 // don't promote ClipData to the parent, since ChooserActivity will
8090 // already start the picked item as the caller, and we can't combine
8091 // the flags in a safe way.
8092
8093 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008094 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008095 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8096 if (intent != null) {
8097 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008098 }
8099 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008100 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008101 try {
8102 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8103 if (intents != null) {
8104 for (int i = 0; i < intents.length; i++) {
8105 final Intent intent = (Intent) intents[i];
8106 if (intent != null) {
8107 migrated |= intent.migrateExtraStreamToClipData();
8108 }
8109 }
8110 }
8111 } catch (ClassCastException e) {
8112 }
8113 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008114
8115 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008116 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008117 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8118 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
8119 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
8120 if (stream != null || text != null || htmlText != null) {
8121 final ClipData clipData = new ClipData(
8122 null, new String[] { getType() },
8123 new ClipData.Item(text, htmlText, null, stream));
8124 setClipData(clipData);
8125 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008126 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008127 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008128 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008129 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008130
8131 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008132 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008133 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8134 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
8135 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
8136 int num = -1;
8137 if (streams != null) {
8138 num = streams.size();
8139 }
8140 if (texts != null) {
8141 if (num >= 0 && num != texts.size()) {
8142 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008143 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008144 }
8145 num = texts.size();
8146 }
8147 if (htmlTexts != null) {
8148 if (num >= 0 && num != htmlTexts.size()) {
8149 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008150 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008151 }
8152 num = htmlTexts.size();
8153 }
8154 if (num > 0) {
8155 final ClipData clipData = new ClipData(
8156 null, new String[] { getType() },
8157 makeClipItem(streams, texts, htmlTexts, 0));
8158
8159 for (int i = 1; i < num; i++) {
8160 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
8161 }
8162
8163 setClipData(clipData);
8164 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008165 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008166 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008167 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008168 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008169 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8170 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8171 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8172 final Uri output;
8173 try {
8174 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8175 } catch (ClassCastException e) {
8176 return false;
8177 }
8178 if (output != null) {
8179 setClipData(ClipData.newRawUri("", output));
8180 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
8181 return true;
8182 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008183 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008184
8185 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008186 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07008187
8188 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
8189 ArrayList<String> htmlTexts, int which) {
8190 Uri uri = streams != null ? streams.get(which) : null;
8191 CharSequence text = texts != null ? texts.get(which) : null;
8192 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
8193 return new ClipData.Item(text, htmlText, null, uri);
8194 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07008195
8196 /** @hide */
8197 public boolean isDocument() {
8198 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
8199 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008200}