blob: 494b53a8150fcd5c6a63266def84b523818733ae [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
Adam Skorydfc7fd72013-08-05 19:23:41 -07001229 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001230 * Output: nothing.
1231 */
1232 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1233 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001234
1235 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001236 * Activity Action: Perform voice assist action.
1237 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001238 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1239 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001240 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001241 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001242 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1246
1247 /**
Adam Skory7140a252013-09-11 12:04:58 +01001248 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1249 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001250 */
1251 public static final String EXTRA_ASSIST_PACKAGE
1252 = "android.intent.extra.ASSIST_PACKAGE";
1253
1254 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001255 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1256 * application package at the time the assist was invoked.
1257 */
1258 public static final String EXTRA_ASSIST_UID
1259 = "android.intent.extra.ASSIST_UID";
1260
1261 /**
Adam Skory7140a252013-09-11 12:04:58 +01001262 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1263 * information supplied by the current foreground app at the time of the assist request.
1264 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001265 */
1266 public static final String EXTRA_ASSIST_CONTEXT
1267 = "android.intent.extra.ASSIST_CONTEXT";
1268
Jim Miller07994402012-05-02 14:22:27 -07001269 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001270 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1271 * keyboard as the primary input device for assistance.
1272 */
1273 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1274 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1275
1276 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001277 * Activity Action: List all available applications
1278 * <p>Input: Nothing.
1279 * <p>Output: nothing.
1280 */
1281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1282 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1283 /**
1284 * Activity Action: Show settings for choosing wallpaper
1285 * <p>Input: Nothing.
1286 * <p>Output: Nothing.
1287 */
1288 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1289 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1290
1291 /**
1292 * Activity Action: Show activity for reporting a bug.
1293 * <p>Input: Nothing.
1294 * <p>Output: Nothing.
1295 */
1296 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1297 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1298
1299 /**
1300 * Activity Action: Main entry point for factory tests. Only used when
1301 * the device is booting in factory test node. The implementing package
1302 * must be installed in the system image.
1303 * <p>Input: nothing
1304 * <p>Output: nothing
1305 */
1306 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1307
1308 /**
1309 * Activity Action: The user pressed the "call" button to go to the dialer
1310 * or other appropriate UI for placing a call.
1311 * <p>Input: Nothing.
1312 * <p>Output: Nothing.
1313 */
1314 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1315 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1316
1317 /**
1318 * Activity Action: Start Voice Command.
1319 * <p>Input: Nothing.
1320 * <p>Output: Nothing.
1321 */
1322 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1323 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001324
1325 /**
1326 * Activity Action: Start action associated with long pressing on the
1327 * search key.
1328 * <p>Input: Nothing.
1329 * <p>Output: Nothing.
1330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001333
Jacek Surazski86b6c532009-05-13 14:38:28 +02001334 /**
1335 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1336 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001337 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001338 * <p>Input: No data is specified. The bug report is passed in using
1339 * an {@link #EXTRA_BUG_REPORT} field.
1340 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001341 *
1342 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001343 */
1344 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1345 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001346
1347 /**
1348 * Activity Action: Show power usage information to the user.
1349 * <p>Input: Nothing.
1350 * <p>Output: Nothing.
1351 */
1352 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1353 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001354
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001355 /**
1356 * Activity Action: Setup wizard to launch after a platform update. This
1357 * activity should have a string meta-data field associated with it,
1358 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1359 * the platform for setup. The activity will be launched only if
1360 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1361 * same value.
1362 * <p>Input: Nothing.
1363 * <p>Output: Nothing.
1364 * @hide
1365 */
1366 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1367 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001368
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001369 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001370 * Activity Action: Show settings for managing network data usage of a
1371 * specific application. Applications should define an activity that offers
1372 * options to control data usage.
1373 */
1374 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1375 public static final String ACTION_MANAGE_NETWORK_USAGE =
1376 "android.intent.action.MANAGE_NETWORK_USAGE";
1377
1378 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001379 * Activity Action: Launch application installer.
1380 * <p>
1381 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001382 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1383 * you can also use "package:<package-name>" to install an application for the
1384 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001385 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1386 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1387 * <p>
1388 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1389 * succeeded.
1390 *
1391 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1392 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1393 * @see #EXTRA_RETURN_RESULT
1394 */
1395 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1396 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1397
1398 /**
1399 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1400 * package. Specifies the installer package name; this package will receive the
1401 * {@link #ACTION_APP_ERROR} intent.
1402 */
1403 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1404 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1405
1406 /**
1407 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1408 * package. Specifies that the application being installed should not be
1409 * treated as coming from an unknown source, but as coming from the app
1410 * invoking the Intent. For this to work you must start the installer with
1411 * startActivityForResult().
1412 */
1413 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1414 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1415
1416 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001417 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1418 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001419 * data field originated from.
1420 */
rich cannings706e8ba2012-08-20 13:20:14 -07001421 public static final String EXTRA_ORIGINATING_URI
1422 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001423
1424 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001425 * This extra can be used with any Intent used to launch an activity, supplying information
1426 * about who is launching that activity. This field contains a {@link android.net.Uri}
1427 * object, typically an http: or https: URI of the web site that the referral came from;
1428 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1429 * a native application that it came from.
1430 *
1431 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1432 * instead of directly retrieving the extra. It is also valid for applications to
1433 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1434 * a string, not a Uri; the field here, if supplied, will always take precedence,
1435 * however.</p>
1436 *
1437 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001438 */
1439 public static final String EXTRA_REFERRER
1440 = "android.intent.extra.REFERRER";
1441
1442 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001443 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1444 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1445 * not be created, in particular when Intent extras are supplied through the
1446 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1447 * schemes.
1448 *
1449 * @see #EXTRA_REFERRER
1450 */
1451 public static final String EXTRA_REFERRER_NAME
1452 = "android.intent.extra.REFERRER_NAME";
1453
1454 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001455 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1456 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1457 * @hide
1458 */
1459 public static final String EXTRA_ORIGINATING_UID
1460 = "android.intent.extra.ORIGINATING_UID";
1461
1462 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001463 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1464 * package. Tells the installer UI to skip the confirmation with the user
1465 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001466 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1467 * will no longer show an interstitial message about updating existing
1468 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001469 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001470 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001471 public static final String EXTRA_ALLOW_REPLACE
1472 = "android.intent.extra.ALLOW_REPLACE";
1473
1474 /**
1475 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1476 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1477 * return to the application the result code of the install/uninstall. The returned result
1478 * code will be {@link android.app.Activity#RESULT_OK} on success or
1479 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1480 */
1481 public static final String EXTRA_RETURN_RESULT
1482 = "android.intent.extra.RETURN_RESULT";
1483
1484 /**
1485 * Package manager install result code. @hide because result codes are not
1486 * yet ready to be exposed.
1487 */
1488 public static final String EXTRA_INSTALL_RESULT
1489 = "android.intent.extra.INSTALL_RESULT";
1490
1491 /**
1492 * Activity Action: Launch application uninstaller.
1493 * <p>
1494 * Input: The data must be a package: URI whose scheme specific part is
1495 * the package name of the current installed package to be uninstalled.
1496 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1497 * <p>
1498 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1499 * succeeded.
1500 */
1501 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1502 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1503
1504 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001505 * Specify whether the package should be uninstalled for all users.
1506 * @hide because these should not be part of normal application flow.
1507 */
1508 public static final String EXTRA_UNINSTALL_ALL_USERS
1509 = "android.intent.extra.UNINSTALL_ALL_USERS";
1510
1511 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001512 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1513 * describing the last run version of the platform that was setup.
1514 * @hide
1515 */
1516 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1517
Svet Ganov3695b8a2015-03-24 16:30:25 -07001518 /**
1519 * Activity action: Launch UI to manage the permissions of an app.
1520 * <p>
1521 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1522 * will be managed by the launched UI.
1523 * </p>
1524 * <p>
1525 * Output: Nothing.
1526 * </p>
1527 *
1528 * @see #EXTRA_PACKAGE_NAME
1529 *
1530 * @hide
1531 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001532 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1533 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1534 "android.intent.action.MANAGE_APP_PERMISSIONS";
1535
1536 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001537 * Activity action: Launch UI to manage permissions.
1538 * <p>
1539 * Input: Nothing.
1540 * </p>
1541 * <p>
1542 * Output: Nothing.
1543 * </p>
1544 *
1545 * @hide
1546 */
Svet Ganov321f0152015-05-16 22:51:50 -07001547 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1548 public static final String ACTION_MANAGE_PERMISSIONS =
1549 "android.intent.action.MANAGE_PERMISSIONS";
1550
1551 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001552 * Intent extra: An app package name.
1553 * <p>
1554 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001555 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001556 *
1557 * @hide
1558 */
1559 @SystemApi
1560 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1561
1562 /**
1563 * Activity action: Launch UI to manage which apps have a given permission.
1564 * <p>
1565 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1566 * to which will be managed by the launched UI.
1567 * </p>
1568 * <p>
1569 * Output: Nothing.
1570 * </p>
1571 *
1572 * @see #EXTRA_PERMISSION_NAME
1573 *
1574 * @hide
1575 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001576 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1577 public static final String ACTION_MANAGE_PERMISSION_APPS =
1578 "android.intent.action.MANAGE_PERMISSION_APPS";
1579
1580 /**
1581 * Intent extra: The name of a permission.
1582 * <p>
1583 * Type: String
1584 * </p>
1585 *
1586 * @hide
1587 */
1588 @SystemApi
1589 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1590
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001591 // ---------------------------------------------------------------------
1592 // ---------------------------------------------------------------------
1593 // Standard intent broadcast actions (see action variable).
1594
1595 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001596 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1597 * <p>
1598 * For historical reasons, the name of this broadcast action refers to the power
1599 * state of the screen but it is actually sent in response to changes in the
1600 * overall interactive state of the device.
1601 * </p><p>
1602 * This broadcast is sent when the device becomes non-interactive which may have
1603 * nothing to do with the screen turning off. To determine the
1604 * actual state of the screen, use {@link android.view.Display#getState}.
1605 * </p><p>
1606 * See {@link android.os.PowerManager#isInteractive} for details.
1607 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001608 * You <em>cannot</em> receive this through components declared in
1609 * manifests, only by explicitly registering for it with
1610 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1611 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001612 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001613 * <p class="note">This is a protected intent that can only be sent
1614 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001615 */
1616 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1617 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001618
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001619 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001620 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1621 * <p>
1622 * For historical reasons, the name of this broadcast action refers to the power
1623 * state of the screen but it is actually sent in response to changes in the
1624 * overall interactive state of the device.
1625 * </p><p>
1626 * This broadcast is sent when the device becomes interactive which may have
1627 * nothing to do with the screen turning on. To determine the
1628 * actual state of the screen, use {@link android.view.Display#getState}.
1629 * </p><p>
1630 * See {@link android.os.PowerManager#isInteractive} for details.
1631 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001632 * You <em>cannot</em> receive this through components declared in
1633 * manifests, only by explicitly registering for it with
1634 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1635 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001636 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001637 * <p class="note">This is a protected intent that can only be sent
1638 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001639 */
1640 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1641 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001642
1643 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001644 * Broadcast Action: Sent after the system stops dreaming.
1645 *
1646 * <p class="note">This is a protected intent that can only be sent by the system.
1647 * It is only sent to registered receivers.</p>
1648 */
1649 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1650 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1651
1652 /**
1653 * Broadcast Action: Sent after the system starts dreaming.
1654 *
1655 * <p class="note">This is a protected intent that can only be sent by the system.
1656 * It is only sent to registered receivers.</p>
1657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1660
1661 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001662 * 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 -07001663 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001664 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001665 * <p class="note">This is a protected intent that can only be sent
1666 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001667 */
1668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001669 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001671 /**
1672 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001673 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001674 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001675 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1676 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001677 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001678 * <p class="note">This is a protected intent that can only be sent
1679 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001680 */
1681 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1682 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1683 /**
1684 * Broadcast Action: The time was set.
1685 */
1686 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1687 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1688 /**
1689 * Broadcast Action: The date has changed.
1690 */
1691 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1692 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1693 /**
1694 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1695 * <ul>
1696 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1697 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001698 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001699 * <p class="note">This is a protected intent that can only be sent
1700 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001701 */
1702 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1703 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1704 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001705 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1706 * DNS entries should be tossed.
1707 * @hide
1708 */
1709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1710 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1711 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001712 * Alarm Changed Action: This is broadcast when the AlarmClock
1713 * application's alarm is set or unset. It is used by the
1714 * AlarmClock application and the StatusBar service.
1715 * @hide
1716 */
1717 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1718 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1719 /**
1720 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1721 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1722 * @hide
1723 */
1724 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1725 public static final String ACTION_SYNC_STATE_CHANGED
1726 = "android.intent.action.SYNC_STATE_CHANGED";
1727 /**
1728 * Broadcast Action: This is broadcast once, after the system has finished
1729 * booting. It can be used to perform application-specific initialization,
1730 * such as installing alarms. You must hold the
1731 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1732 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001733 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001734 * <p class="note">This is a protected intent that can only be sent
1735 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001736 */
1737 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1738 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1739 /**
1740 * Broadcast Action: This is broadcast when a user action should request a
1741 * temporary system dialog to dismiss. Some examples of temporary system
1742 * dialogs are the notification window-shade and the recent tasks dialog.
1743 */
1744 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1745 /**
1746 * Broadcast Action: Trigger the download and eventual installation
1747 * of a package.
1748 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001749 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001750 * <p class="note">This is a protected intent that can only be sent
1751 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001752 *
1753 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001754 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001755 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001756 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1757 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1758 /**
1759 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001760 * device. The data contains the name of the package. Note that the
1761 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001762 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001763 * <ul>
1764 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1765 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1766 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1767 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001768 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001769 * <p class="note">This is a protected intent that can only be sent
1770 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1773 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1774 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001775 * Broadcast Action: A new version of an application package has been
1776 * installed, replacing an existing version that was previously installed.
1777 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001778 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001779 * <ul>
1780 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1781 * </ul>
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 Projectc2ad2412009-03-19 23:08:54 -07001785 */
1786 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1787 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1788 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001789 * Broadcast Action: A new version of your application has been installed
1790 * over an existing one. This is only sent to the application that was
1791 * replaced. It does not contain any additional data; to receive it, just
1792 * use an intent filter for this action.
1793 *
1794 * <p class="note">This is a protected intent that can only be sent
1795 * by the system.
1796 */
1797 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1798 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1799 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001800 * Broadcast Action: An existing application package has been removed from
1801 * the device. The data contains the name of the package. The package
1802 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001803 * <ul>
1804 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1805 * to the package.
1806 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1807 * application -- data and code -- is being removed.
1808 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1809 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1810 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001811 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1817 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001818 * Broadcast Action: An existing application package has been completely
1819 * removed from the device. The data contains the name of the package.
1820 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1821 * {@link #EXTRA_DATA_REMOVED} is true and
1822 * {@link #EXTRA_REPLACING} is false of that broadcast.
1823 *
1824 * <ul>
1825 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1826 * to the package.
1827 * </ul>
1828 *
1829 * <p class="note">This is a protected intent that can only be sent
1830 * by the system.
1831 */
1832 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1833 public static final String ACTION_PACKAGE_FULLY_REMOVED
1834 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1835 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001836 * Broadcast Action: An existing application package has been changed (e.g.
1837 * a component has been enabled or disabled). The data contains the name of
1838 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001839 * <ul>
1840 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001841 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001842 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001843 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1844 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001845 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001846 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001847 * <p class="note">This is a protected intent that can only be sent
1848 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 */
1850 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1851 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1852 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001853 * @hide
1854 * Broadcast Action: Ask system services if there is any reason to
1855 * restart the given package. The data contains the name of the
1856 * package.
1857 * <ul>
1858 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1859 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1860 * </ul>
1861 *
1862 * <p class="note">This is a protected intent that can only be sent
1863 * by the system.
1864 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08001865 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001866 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1867 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1868 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001869 * Broadcast Action: The user has restarted a package, and all of its
1870 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001871 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001872 * be removed. Note that the restarted package does <em>not</em>
1873 * receive this broadcast.
1874 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001875 * <ul>
1876 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1877 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001878 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001879 * <p class="note">This is a protected intent that can only be sent
1880 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1884 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001885 * Broadcast Action: The user has cleared the data of a package. This should
1886 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001887 * its persistent data is erased and this broadcast sent.
1888 * Note that the cleared package does <em>not</em>
1889 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001890 * <ul>
1891 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1892 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001893 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001894 * <p class="note">This is a protected intent that can only be sent
1895 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001896 */
1897 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1898 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1899 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001900 * Broadcast Action: A user ID has been removed from the system. The user
1901 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001902 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001903 * <p class="note">This is a protected intent that can only be sent
1904 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1907 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001908
1909 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001910 * Broadcast Action: Sent to the installer package of an application
1911 * when that application is first launched (that is the first time it
1912 * is moved out of the stopped state). The data contains the name of the package.
1913 *
1914 * <p class="note">This is a protected intent that can only be sent
1915 * by the system.
1916 */
1917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1918 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1919
1920 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001921 * Broadcast Action: Sent to the system package verifier when a package
1922 * needs to be verified. The data contains the package URI.
1923 * <p class="note">
1924 * This is a protected intent that can only be sent by the system.
1925 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1929
1930 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001931 * Broadcast Action: Sent to the system package verifier when a package is
1932 * verified. The data contains the package URI.
1933 * <p class="note">
1934 * This is a protected intent that can only be sent by the system.
1935 */
1936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1937 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1938
1939 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08001940 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
1941 * needs to be verified. The data contains the filter data hosts to be verified against.
1942 * <p class="note">
1943 * This is a protected intent that can only be sent by the system.
1944 * </p>
1945 *
1946 * @hide
1947 */
1948 @SystemApi
1949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
1951
1952 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001953 * Broadcast Action: Resources for a set of packages (which were
1954 * previously unavailable) are currently
1955 * available since the media on which they exist is available.
1956 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1957 * list of packages whose availability changed.
1958 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1959 * list of uids of packages whose availability changed.
1960 * Note that the
1961 * packages in this list do <em>not</em> receive this broadcast.
1962 * The specified set of packages are now available on the system.
1963 * <p>Includes the following extras:
1964 * <ul>
1965 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1966 * whose resources(were previously unavailable) are currently available.
1967 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1968 * packages whose resources(were previously unavailable)
1969 * are currently available.
1970 * </ul>
1971 *
1972 * <p class="note">This is a protected intent that can only be sent
1973 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001976 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1977 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001978
1979 /**
1980 * Broadcast Action: Resources for a set of packages are currently
1981 * unavailable since the media on which they exist is unavailable.
1982 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1983 * list of packages whose availability changed.
1984 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1985 * list of uids of packages whose availability changed.
1986 * The specified set of packages can no longer be
1987 * launched and are practically unavailable on the system.
1988 * <p>Inclues the following extras:
1989 * <ul>
1990 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1991 * whose resources are no longer available.
1992 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1993 * whose resources are no longer available.
1994 * </ul>
1995 *
1996 * <p class="note">This is a protected intent that can only be sent
1997 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002000 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002001 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002002
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 /**
2004 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002005 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002006 * This should <em>only</em> be used to determine when the wallpaper
2007 * has changed to show the new wallpaper to the user. You should certainly
2008 * never, in response to this, change the wallpaper or other attributes of
2009 * it such as the suggested size. That would be crazy, right? You'd cause
2010 * all kinds of loops, especially if other apps are doing similar things,
2011 * right? Of course. So please don't do this.
2012 *
2013 * @deprecated Modern applications should use
2014 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2015 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2016 * shown behind their UI, rather than watching for this broadcast and
2017 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002019 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002020 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2021 /**
2022 * Broadcast Action: The current device {@link android.content.res.Configuration}
2023 * (orientation, locale, etc) has changed. When such a change happens, the
2024 * UIs (view hierarchy) will need to be rebuilt based on this new
2025 * information; for the most part, applications don't need to worry about
2026 * this, because the system will take care of stopping and restarting the
2027 * application to make sure it sees the new changes. Some system code that
2028 * can not be restarted will need to watch for this action and handle it
2029 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002030 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002031 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002032 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002033 * in manifests, only by explicitly registering for it with
2034 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2035 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002036 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002037 * <p class="note">This is a protected intent that can only be sent
2038 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002039 *
2040 * @see android.content.res.Configuration
2041 */
2042 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2043 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2044 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002045 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002046 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002047 * <p class="note">This is a protected intent that can only be sent
2048 * by the system.
2049 */
2050 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2051 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2052 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002053 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2054 * charging state, level, and other information about the battery.
2055 * See {@link android.os.BatteryManager} for documentation on the
2056 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002057 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002058 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002059 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002060 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002061 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002062 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2063 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2064 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2065 * broadcasts that are sent and can be received through manifest
2066 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002067 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002068 * <p class="note">This is a protected intent that can only be sent
2069 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2072 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2073 /**
2074 * Broadcast Action: Indicates low battery condition on the device.
2075 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002076 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002077 * <p class="note">This is a protected intent that can only be sent
2078 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002079 */
2080 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2081 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2082 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002083 * Broadcast Action: Indicates the battery is now okay after being low.
2084 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2085 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002086 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2092 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002093 * Broadcast Action: External power has been connected to the device.
2094 * This is intended for applications that wish to register specifically to this notification.
2095 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2096 * stay active to receive this notification. This action can be used to implement actions
2097 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002098 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002099 * <p class="note">This is a protected intent that can only be sent
2100 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002101 */
2102 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002103 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002104 /**
2105 * Broadcast Action: External power has been removed from the device.
2106 * This is intended for applications that wish to register specifically to this notification.
2107 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2108 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002109 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002110 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002111 * <p class="note">This is a protected intent that can only be sent
2112 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002115 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002116 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002117 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002118 * Broadcast Action: Device is shutting down.
2119 * This is broadcast when the device is being shut down (completely turned
2120 * off, not sleeping). Once the broadcast is complete, the final shutdown
2121 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002122 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002123 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002124 * <p class="note">This is a protected intent that can only be sent
2125 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002126 * <p>May include the following extras:
2127 * <ul>
2128 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2129 * shutdown is only for userspace processes. If not set, assumed to be false.
2130 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002131 */
2132 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002133 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002134 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002135 * Activity Action: Start this activity to request system shutdown.
2136 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
2137 * to request confirmation from the user before shutting down.
2138 *
2139 * <p class="note">This is a protected intent that can only be sent
2140 * by the system.
2141 *
2142 * {@hide}
2143 */
2144 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2145 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002146 * Broadcast Action: A sticky broadcast that indicates low memory
2147 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002148 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002149 * <p class="note">This is a protected intent that can only be sent
2150 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002151 */
2152 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2153 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2154 /**
2155 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002156 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002157 * <p class="note">This is a protected intent that can only be sent
2158 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002159 */
2160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2161 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2162 /**
Jake Hambybb371632010-08-23 18:16:48 -07002163 * Broadcast Action: A sticky broadcast that indicates a memory full
2164 * condition on the device. This is intended for activities that want
2165 * to be able to fill the data partition completely, leaving only
2166 * enough free space to prevent system-wide SQLite failures.
2167 *
2168 * <p class="note">This is a protected intent that can only be sent
2169 * by the system.
2170 *
2171 * {@hide}
2172 */
2173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2174 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2175 /**
2176 * Broadcast Action: Indicates memory full condition on the device
2177 * no longer exists.
2178 *
2179 * <p class="note">This is a protected intent that can only be sent
2180 * by the system.
2181 *
2182 * {@hide}
2183 */
2184 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2185 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2186 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002187 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2188 * and package management should be started.
2189 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2190 * notification.
2191 */
2192 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2194 /**
2195 * Broadcast Action: The device has entered USB Mass Storage mode.
2196 * This is used mainly for the USB Settings panel.
2197 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2198 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002199 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002200 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002201 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002202 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2203
2204 /**
2205 * Broadcast Action: The device has exited USB Mass Storage mode.
2206 * This is used mainly for the USB Settings panel.
2207 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2208 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002209 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002210 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002211 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002212 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2213
2214 /**
2215 * Broadcast Action: External media has been removed.
2216 * The path to the mount point for the removed media is contained in the Intent.mData field.
2217 */
2218 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2219 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2220
2221 /**
2222 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002223 * 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 -07002224 */
2225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2226 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2227
2228 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002229 * Broadcast Action: External media is present, and being disk-checked
2230 * 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 -08002231 */
2232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2233 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2234
2235 /**
2236 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2237 * 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 -08002238 */
2239 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2240 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2241
2242 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002243 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002244 * 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 -07002245 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2246 * media was mounted read only.
2247 */
2248 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2249 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2250
2251 /**
2252 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002253 * 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 -07002254 */
2255 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2256 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2257
2258 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002259 * Broadcast Action: External media is no longer being shared via USB mass storage.
2260 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2261 *
2262 * @hide
2263 */
2264 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2265
2266 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002267 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2268 * The path to the mount point for the removed media is contained in the Intent.mData field.
2269 */
2270 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2271 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2272
2273 /**
2274 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002275 * 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 -07002276 */
2277 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2278 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2279
2280 /**
2281 * Broadcast Action: User has expressed the desire to remove the external storage media.
2282 * Applications should close all files they have open within the mount point when they receive this intent.
2283 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2284 */
2285 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2286 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2287
2288 /**
2289 * Broadcast Action: The media scanner has started scanning a directory.
2290 * The path to the directory being scanned is contained in the Intent.mData field.
2291 */
2292 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2293 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2294
2295 /**
2296 * Broadcast Action: The media scanner has finished scanning a directory.
2297 * The path to the scanned directory is contained in the Intent.mData field.
2298 */
2299 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2300 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2301
2302 /**
2303 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2304 * The path to the file is contained in the Intent.mData field.
2305 */
2306 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2307 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2308
2309 /**
2310 * Broadcast Action: The "Media Button" was pressed. Includes a single
2311 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2312 * caused the broadcast.
2313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2316
2317 /**
2318 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2319 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2320 * caused the broadcast.
2321 */
2322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2323 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2324
2325 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2326 // location; they are not general-purpose actions.
2327
2328 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002329 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002330 */
2331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2332 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2333 "android.intent.action.GTALK_CONNECTED";
2334
2335 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002336 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002337 */
2338 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2339 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2340 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002341
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002342 /**
2343 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002344 */
2345 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2346 public static final String ACTION_INPUT_METHOD_CHANGED =
2347 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002348
2349 /**
2350 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2351 * more radios have been turned off or on. The intent will have the following extra value:</p>
2352 * <ul>
2353 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2354 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2355 * turned off</li>
2356 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002357 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002358 * <p class="note">This is a protected intent that can only be sent
2359 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002360 */
2361 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2362 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2363
2364 /**
2365 * Broadcast Action: Some content providers have parts of their namespace
2366 * where they publish new events or items that the user may be especially
2367 * interested in. For these things, they may broadcast this action when the
2368 * set of interesting items change.
2369 *
2370 * For example, GmailProvider sends this notification when the set of unread
2371 * mail in the inbox changes.
2372 *
2373 * <p>The data of the intent identifies which part of which provider
2374 * changed. When queried through the content resolver, the data URI will
2375 * return the data set in question.
2376 *
2377 * <p>The intent will have the following extra values:
2378 * <ul>
2379 * <li><em>count</em> - The number of items in the data set. This is the
2380 * same as the number of items in the cursor returned by querying the
2381 * data URI. </li>
2382 * </ul>
2383 *
2384 * This intent will be sent at boot (if the count is non-zero) and when the
2385 * data set changes. It is possible for the data set to change without the
2386 * count changing (for example, if a new unread message arrives in the same
2387 * sync operation in which a message is archived). The phone should still
2388 * ring/vibrate/etc as normal in this case.
2389 */
2390 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2391 public static final String ACTION_PROVIDER_CHANGED =
2392 "android.intent.action.PROVIDER_CHANGED";
2393
2394 /**
2395 * Broadcast Action: Wired Headset plugged in or unplugged.
2396 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002397 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2398 * and documentation.
2399 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002400 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002401 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002402 */
2403 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002404 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002405
2406 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002407 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2408 * <ul>
2409 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2410 * </ul>
2411 *
2412 * <p class="note">This is a protected intent that can only be sent
2413 * by the system.
2414 *
2415 * @hide
2416 */
2417 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2418 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2419 = "android.intent.action.ADVANCED_SETTINGS";
2420
2421 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002422 * Broadcast Action: Sent after application restrictions are changed.
2423 *
2424 * <p class="note">This is a protected intent that can only be sent
2425 * by the system.</p>
2426 */
2427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2428 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2429 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2430
2431 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002432 * Broadcast Action: An outgoing call is about to be placed.
2433 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002434 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002435 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002436 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002437 * the phone number originally intended to be dialed.</li>
2438 * </ul>
2439 * <p>Once the broadcast is finished, the resultData is used as the actual
2440 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002441 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002442 * outgoing call in turn: for example, a parental control application
2443 * might verify that the user is authorized to place the call at that
2444 * time, then a number-rewriting application might add an area code if
2445 * one was not specified.</p>
2446 * <p>For consistency, any receiver whose purpose is to prohibit phone
2447 * calls should have a priority of 0, to ensure it will see the final
2448 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002449 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002450 * should have a positive priority.
2451 * Negative priorities are reserved for the system for this broadcast;
2452 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002453 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2454 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002455 * <p>Emergency calls cannot be intercepted using this mechanism, and
2456 * other calls cannot be modified to call emergency numbers using this
2457 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002458 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2459 * call to use their own service instead. Those apps should first prevent
2460 * the call from being placed by setting resultData to <code>null</code>
2461 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002462 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002463 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2464 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002465 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002466 * <p class="note">This is a protected intent that can only be sent
2467 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002468 */
2469 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2470 public static final String ACTION_NEW_OUTGOING_CALL =
2471 "android.intent.action.NEW_OUTGOING_CALL";
2472
2473 /**
2474 * Broadcast Action: Have the device reboot. This is only for use by
2475 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002476 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002477 * <p class="note">This is a protected intent that can only be sent
2478 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002479 */
2480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2481 public static final String ACTION_REBOOT =
2482 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002483
Wei Huang97ecc9c2009-05-11 17:44:20 -07002484 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002485 * Broadcast Action: A sticky broadcast for changes in the physical
2486 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002487 *
2488 * <p>The intent will have the following extra values:
2489 * <ul>
2490 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002491 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002492 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002493 * <p>This is intended for monitoring the current physical dock state.
2494 * See {@link android.app.UiModeManager} for the normal API dealing with
2495 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002496 */
2497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2498 public static final String ACTION_DOCK_EVENT =
2499 "android.intent.action.DOCK_EVENT";
2500
2501 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002502 * Broadcast Action: A broadcast when idle maintenance can be started.
2503 * This means that the user is not interacting with the device and is
2504 * not expected to do so soon. Typical use of the idle maintenance is
2505 * to perform somehow expensive tasks that can be postponed at a moment
2506 * when they will not degrade user experience.
2507 * <p>
2508 * <p class="note">In order to keep the device responsive in case of an
2509 * unexpected user interaction, implementations of a maintenance task
2510 * should be interruptible. In such a scenario a broadcast with action
2511 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2512 * should not do the maintenance work in
2513 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2514 * maintenance service by {@link Context#startService(Intent)}. Also
2515 * you should hold a wake lock while your maintenance service is running
2516 * to prevent the device going to sleep.
2517 * </p>
2518 * <p>
2519 * <p class="note">This is a protected intent that can only be sent by
2520 * the system.
2521 * </p>
2522 *
2523 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002524 *
2525 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002526 */
2527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2528 public static final String ACTION_IDLE_MAINTENANCE_START =
2529 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2530
2531 /**
2532 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2533 * This means that the user was not interacting with the device as a result
2534 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2535 * was sent and now the user started interacting with the device. Typical
2536 * use of the idle maintenance is to perform somehow expensive tasks that
2537 * can be postponed at a moment when they will not degrade user experience.
2538 * <p>
2539 * <p class="note">In order to keep the device responsive in case of an
2540 * unexpected user interaction, implementations of a maintenance task
2541 * should be interruptible. Hence, on receiving a broadcast with this
2542 * action, the maintenance task should be interrupted as soon as possible.
2543 * In other words, you should not do the maintenance work in
2544 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2545 * maintenance service that was started on receiving of
2546 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2547 * lock you acquired when your maintenance service started.
2548 * </p>
2549 * <p class="note">This is a protected intent that can only be sent
2550 * by the system.
2551 *
2552 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002553 *
2554 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002555 */
2556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2557 public static final String ACTION_IDLE_MAINTENANCE_END =
2558 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2559
2560 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002561 * Broadcast Action: a remote intent is to be broadcasted.
2562 *
2563 * A remote intent is used for remote RPC between devices. The remote intent
2564 * is serialized and sent from one device to another device. The receiving
2565 * device parses the remote intent and broadcasts it. Note that anyone can
2566 * broadcast a remote intent. However, if the intent receiver of the remote intent
2567 * does not trust intent broadcasts from arbitrary intent senders, it should require
2568 * the sender to hold certain permissions so only trusted sender's broadcast will be
2569 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002570 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002571 */
2572 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002573 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002574
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002575 /**
2576 * Broadcast Action: hook for permforming cleanup after a system update.
2577 *
2578 * The broadcast is sent when the system is booting, before the
2579 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2580 * image. A receiver for this should do its work and then disable itself
2581 * so that it does not get run again at the next boot.
2582 * @hide
2583 */
2584 public static final String ACTION_PRE_BOOT_COMPLETED =
2585 "android.intent.action.PRE_BOOT_COMPLETED";
2586
Amith Yamasani13593602012-03-22 16:16:17 -07002587 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002588 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002589 * on restricted users. The broadcast intent contains an extra
2590 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2591 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2592 * String[] depending on the restriction type.<p/>
2593 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002594 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2595 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2596 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002597 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2598 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002599 * @see RestrictionEntry
2600 */
2601 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2602 "android.intent.action.GET_RESTRICTION_ENTRIES";
2603
2604 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002605 * Sent the first time a user is starting, to allow system apps to
2606 * perform one time initialization. (This will not be seen by third
2607 * party applications because a newly initialized user does not have any
2608 * third party applications installed for it.) This is sent early in
2609 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002610 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2611 * broadcast, since it is part of a visible user interaction; be as quick
2612 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002613 */
2614 public static final String ACTION_USER_INITIALIZE =
2615 "android.intent.action.USER_INITIALIZE";
2616
2617 /**
2618 * Sent when a user switch is happening, causing the process's user to be
2619 * brought to the foreground. This is only sent to receivers registered
2620 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2621 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002622 * foreground. This is sent as a foreground
2623 * broadcast, since it is part of a visible user interaction; be as quick
2624 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002625 */
2626 public static final String ACTION_USER_FOREGROUND =
2627 "android.intent.action.USER_FOREGROUND";
2628
2629 /**
2630 * Sent when a user switch is happening, causing the process's user to be
2631 * sent to the background. This is only sent to receivers registered
2632 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2633 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002634 * background. This is sent as a foreground
2635 * broadcast, since it is part of a visible user interaction; be as quick
2636 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002637 */
2638 public static final String ACTION_USER_BACKGROUND =
2639 "android.intent.action.USER_BACKGROUND";
2640
2641 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002642 * Broadcast sent to the system when a user is added. Carries an extra
2643 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2644 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002645 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002646 * @hide
2647 */
2648 public static final String ACTION_USER_ADDED =
2649 "android.intent.action.USER_ADDED";
2650
2651 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002652 * Broadcast sent by the system when a user is started. Carries an extra
2653 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002654 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002655 * that has been started. This is sent as a foreground
2656 * broadcast, since it is part of a visible user interaction; be as quick
2657 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002658 * @hide
2659 */
2660 public static final String ACTION_USER_STARTED =
2661 "android.intent.action.USER_STARTED";
2662
2663 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002664 * Broadcast sent when a user is in the process of starting. Carries an extra
2665 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2666 * sent to registered receivers, not manifest receivers. It is sent to all
2667 * users (including the one that is being started). You must hold
2668 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2669 * this broadcast. This is sent as a background broadcast, since
2670 * its result is not part of the primary UX flow; to safely keep track of
2671 * started/stopped state of a user you can use this in conjunction with
2672 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2673 * other user state broadcasts since those are foreground broadcasts so can
2674 * execute in a different order.
2675 * @hide
2676 */
2677 public static final String ACTION_USER_STARTING =
2678 "android.intent.action.USER_STARTING";
2679
2680 /**
2681 * Broadcast sent when a user is going to be stopped. Carries an extra
2682 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2683 * sent to registered receivers, not manifest receivers. It is sent to all
2684 * users (including the one that is being stopped). You must hold
2685 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2686 * this broadcast. The user will not stop until all receivers have
2687 * handled the broadcast. This is sent as a background broadcast, since
2688 * its result is not part of the primary UX flow; to safely keep track of
2689 * started/stopped state of a user you can use this in conjunction with
2690 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2691 * other user state broadcasts since those are foreground broadcasts so can
2692 * execute in a different order.
2693 * @hide
2694 */
2695 public static final String ACTION_USER_STOPPING =
2696 "android.intent.action.USER_STOPPING";
2697
2698 /**
2699 * Broadcast sent to the system when a user is stopped. Carries an extra
2700 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2701 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2702 * specific package. This is only sent to registered receivers, not manifest
2703 * receivers. It is sent to all running users <em>except</em> the one that
2704 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002705 * @hide
2706 */
2707 public static final String ACTION_USER_STOPPED =
2708 "android.intent.action.USER_STOPPED";
2709
2710 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002711 * 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 -07002712 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002713 * one that has been removed. The user will not be completely removed until all receivers have
2714 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002715 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002716 * @hide
2717 */
2718 public static final String ACTION_USER_REMOVED =
2719 "android.intent.action.USER_REMOVED";
2720
2721 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002722 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002723 * the userHandle of the user to become the current one. This is only sent to
2724 * registered receivers, not manifest receivers. It is sent to all running users.
2725 * You must hold
2726 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002727 * @hide
2728 */
2729 public static final String ACTION_USER_SWITCHED =
2730 "android.intent.action.USER_SWITCHED";
2731
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002732 /**
2733 * Broadcast sent to the system when a user's information changes. Carries an extra
2734 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002735 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002736 * @hide
2737 */
2738 public static final String ACTION_USER_INFO_CHANGED =
2739 "android.intent.action.USER_INFO_CHANGED";
2740
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002741 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002742 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2743 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002744 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2745 * that need to display merged content across both primary and managed profiles need to
2746 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002747 * not manifest receivers.
2748 */
2749 public static final String ACTION_MANAGED_PROFILE_ADDED =
2750 "android.intent.action.MANAGED_PROFILE_ADDED";
2751
2752 /**
2753 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002754 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2755 * Only applications (for example Launchers) that need to display merged content across both
2756 * primary and managed profiles need to worry about this broadcast. This is only sent to
2757 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002758 */
2759 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2760 "android.intent.action.MANAGED_PROFILE_REMOVED";
2761
2762 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002763 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2764 */
2765 public static final String ACTION_QUICK_CLOCK =
2766 "android.intent.action.QUICK_CLOCK";
2767
Michael Wright0087a142013-02-05 16:29:39 -08002768 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002769 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002770 * @hide
2771 */
2772 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2773 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2774
Justin Kohd378ad72013-04-01 12:18:26 -07002775 /**
2776 * Broadcast Action: A global button was pressed. Includes a single
2777 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2778 * caused the broadcast.
2779 * @hide
2780 */
2781 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2782
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002783 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002784 * Activity Action: Allow the user to select and return one or more existing
2785 * documents. When invoked, the system will display the various
2786 * {@link DocumentsProvider} instances installed on the device, letting the
2787 * user interactively navigate through them. These documents include local
2788 * media, such as photos and video, and documents provided by installed
2789 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002790 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002791 * Each document is represented as a {@code content://} URI backed by a
2792 * {@link DocumentsProvider}, which can be opened as a stream with
2793 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2794 * {@link android.provider.DocumentsContract.Document} metadata.
2795 * <p>
2796 * All selected documents are returned to the calling application with
2797 * persistable read and write permission grants. If you want to maintain
2798 * access to the documents across device reboots, you need to explicitly
2799 * take the persistable permissions using
2800 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2801 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002802 * Callers must indicate the acceptable document MIME types through
2803 * {@link #setType(String)}. For example, to select photos, use
2804 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2805 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2806 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002807 * <p>
2808 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002809 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2810 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002811 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002812 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2813 * returned URIs can be opened with
2814 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002815 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002816 * Output: The URI of the item that was picked, returned in
2817 * {@link #getData()}. This must be a {@code content://} URI so that any
2818 * receiver can access it. If multiple documents were selected, they are
2819 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002820 *
2821 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002822 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002823 * @see #ACTION_CREATE_DOCUMENT
2824 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002825 */
2826 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2827 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2828
2829 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002830 * Activity Action: Allow the user to create a new document. When invoked,
2831 * the system will display the various {@link DocumentsProvider} instances
2832 * installed on the device, letting the user navigate through them. The
2833 * returned document may be a newly created document with no content, or it
2834 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002835 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002836 * Each document is represented as a {@code content://} URI backed by a
2837 * {@link DocumentsProvider}, which can be opened as a stream with
2838 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2839 * {@link android.provider.DocumentsContract.Document} metadata.
2840 * <p>
2841 * Callers must indicate the concrete MIME type of the document being
2842 * created by setting {@link #setType(String)}. This MIME type cannot be
2843 * changed after the document is created.
2844 * <p>
2845 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2846 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002847 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002848 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2849 * returned URIs can be opened with
2850 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002851 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002852 * Output: The URI of the item that was created. This must be a
2853 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002854 *
2855 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002856 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002857 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002858 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002859 */
2860 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2861 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2862
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002863 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002864 * Activity Action: Allow the user to pick a directory subtree. When
2865 * invoked, the system will display the various {@link DocumentsProvider}
2866 * instances installed on the device, letting the user navigate through
2867 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002868 * <p>
2869 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002870 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2871 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2872 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002873 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002874 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002875 *
2876 * @see DocumentsContract
2877 */
2878 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002879 public static final String
2880 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002881
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002882 /** {@hide} */
2883 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2884
Christopher Tate6597e342015-02-17 12:15:25 -08002885 /**
2886 * Broadcast action: report that a settings element is being restored from backup. The intent
2887 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
2888 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
2889 * is the value of that settings entry prior to the restore operation. All of these values are
2890 * represented as strings.
2891 *
2892 * <p>This broadcast is sent only for settings provider entries known to require special handling
2893 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
2894 * the provider's backup agent implementation.
2895 *
2896 * @see #EXTRA_SETTING_NAME
2897 * @see #EXTRA_SETTING_PREVIOUS_VALUE
2898 * @see #EXTRA_SETTING_NEW_VALUE
2899 * {@hide}
2900 */
2901 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
2902
2903 /** {@hide} */
2904 public static final String EXTRA_SETTING_NAME = "setting_name";
2905 /** {@hide} */
2906 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
2907 /** {@hide} */
2908 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
2909
Clara Bayarri0a26157a2015-03-26 18:38:55 +00002910 /**
2911 * Activity Action: Process a piece of text.
2912 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
2913 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
2914 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
2915 */
2916 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2917 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
2918 /**
2919 * The name of the extra used to define the text to be processed.
2920 */
2921 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
2922 /**
2923 * The name of the extra used to define if the processed text will be used as read-only.
2924 */
2925 public static final String EXTRA_PROCESS_TEXT_READONLY =
2926 "android.intent.extra.PROCESS_TEXT_READONLY";
2927
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002928 // ---------------------------------------------------------------------
2929 // ---------------------------------------------------------------------
2930 // Standard intent categories (see addCategory()).
2931
2932 /**
2933 * Set if the activity should be an option for the default action
2934 * (center press) to perform on a piece of data. Setting this will
2935 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002936 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002937 * Intent when initiating an action -- it is for use in intent filters
2938 * specified in packages.
2939 */
2940 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2941 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2942 /**
2943 * Activities that can be safely invoked from a browser must support this
2944 * category. For example, if the user is viewing a web page or an e-mail
2945 * and clicks on a link in the text, the Intent generated execute that
2946 * link will require the BROWSABLE category, so that only activities
2947 * supporting this category will be considered as possible actions. By
2948 * supporting this category, you are promising that there is nothing
2949 * damaging (without user intervention) that can happen by invoking any
2950 * matching Intent.
2951 */
2952 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2953 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2954 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002955 * Categories for activities that can participate in voice interaction.
2956 * An activity that supports this category must be prepared to run with
2957 * no UI shown at all (though in some case it may have a UI shown), and
2958 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2959 */
2960 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2961 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2962 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002963 * Set if the activity should be considered as an alternative action to
2964 * the data the user is currently viewing. See also
2965 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2966 * applies to the selection in a list of items.
2967 *
2968 * <p>Supporting this category means that you would like your activity to be
2969 * displayed in the set of alternative things the user can do, usually as
2970 * part of the current activity's options menu. You will usually want to
2971 * include a specific label in the &lt;intent-filter&gt; of this action
2972 * describing to the user what it does.
2973 *
2974 * <p>The action of IntentFilter with this category is important in that it
2975 * describes the specific action the target will perform. This generally
2976 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2977 * a specific name such as "com.android.camera.action.CROP. Only one
2978 * alternative of any particular action will be shown to the user, so using
2979 * a specific action like this makes sure that your alternative will be
2980 * displayed while also allowing other applications to provide their own
2981 * overrides of that particular action.
2982 */
2983 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2984 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2985 /**
2986 * Set if the activity should be considered as an alternative selection
2987 * action to the data the user has currently selected. This is like
2988 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2989 * of items from which the user can select, giving them alternatives to the
2990 * default action that will be performed on it.
2991 */
2992 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2993 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2994 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002995 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002996 */
2997 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2998 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2999 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003000 * Should be displayed in the top-level launcher.
3001 */
3002 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3003 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3004 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003005 * Indicates an activity optimized for Leanback mode, and that should
3006 * be displayed in the Leanback launcher.
3007 */
3008 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3009 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3010 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003011 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3012 * @hide
3013 */
3014 @SystemApi
3015 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3016 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003017 * Provides information about the package it is in; typically used if
3018 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3019 * a front-door to the user without having to be shown in the all apps list.
3020 */
3021 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3022 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3023 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003024 * This is the home activity, that is the first activity that is displayed
3025 * when the device boots.
3026 */
3027 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3028 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3029 /**
3030 * This activity is a preference panel.
3031 */
3032 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3033 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3034 /**
3035 * This activity is a development preference panel.
3036 */
3037 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3038 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3039 /**
3040 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003041 */
3042 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3043 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3044 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003045 * This activity allows the user to browse and download new applications.
3046 */
3047 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3048 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3049 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003050 * This activity may be exercised by the monkey or other automated test tools.
3051 */
3052 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3053 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3054 /**
3055 * To be used as a test (not part of the normal user experience).
3056 */
3057 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3058 /**
3059 * To be used as a unit test (run through the Test Harness).
3060 */
3061 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3062 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003063 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003064 * experience).
3065 */
3066 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003067
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003068 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003069 * Used to indicate that an intent only wants URIs that can be opened with
3070 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3071 * must support at least the columns defined in {@link OpenableColumns} when
3072 * queried.
3073 *
3074 * @see #ACTION_GET_CONTENT
3075 * @see #ACTION_OPEN_DOCUMENT
3076 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003077 */
3078 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3079 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3080
3081 /**
3082 * To be used as code under test for framework instrumentation tests.
3083 */
3084 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3085 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003086 /**
3087 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003088 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3089 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003090 */
3091 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3092 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3093 /**
3094 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003095 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3096 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003097 */
3098 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3099 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003100 /**
3101 * An activity to run when device is inserted into a analog (low end) dock.
3102 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3103 * information, see {@link android.app.UiModeManager}.
3104 */
3105 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3106 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3107
3108 /**
3109 * An activity to run when device is inserted into a digital (high end) dock.
3110 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3111 * information, see {@link android.app.UiModeManager}.
3112 */
3113 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3114 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003115
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003116 /**
3117 * Used to indicate that the activity can be used in a car environment.
3118 */
3119 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3120 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3121
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003122 // ---------------------------------------------------------------------
3123 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003124 // Application launch intent categories (see addCategory()).
3125
3126 /**
3127 * Used with {@link #ACTION_MAIN} to launch the browser application.
3128 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003129 * <p>NOTE: This should not be used as the primary key of an Intent,
3130 * since it will not result in the app launching with the correct
3131 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003132 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003133 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003134 */
3135 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3136 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3137
3138 /**
3139 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3140 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003141 * <p>NOTE: This should not be used as the primary key of an Intent,
3142 * since it will not result in the app launching with the correct
3143 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003144 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003145 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003146 */
3147 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3148 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3149
3150 /**
3151 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3152 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003153 * <p>NOTE: This should not be used as the primary key of an Intent,
3154 * since it will not result in the app launching with the correct
3155 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003156 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003157 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003158 */
3159 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3160 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3161
3162 /**
3163 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3164 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003165 * <p>NOTE: This should not be used as the primary key of an Intent,
3166 * since it will not result in the app launching with the correct
3167 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003168 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003169 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003170 */
3171 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3172 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3173
3174 /**
3175 * Used with {@link #ACTION_MAIN} to launch the email application.
3176 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003177 * <p>NOTE: This should not be used as the primary key of an Intent,
3178 * since it will not result in the app launching with the correct
3179 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003180 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003181 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003182 */
3183 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3184 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3185
3186 /**
3187 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3188 * The activity should be able to view and manipulate image and video files
3189 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003190 * <p>NOTE: This should not be used as the primary key of an Intent,
3191 * since it will not result in the app launching with the correct
3192 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003193 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003194 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003195 */
3196 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3197 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3198
3199 /**
3200 * Used with {@link #ACTION_MAIN} to launch the maps application.
3201 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003202 * <p>NOTE: This should not be used as the primary key of an Intent,
3203 * since it will not result in the app launching with the correct
3204 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003205 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003206 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003207 */
3208 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3209 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3210
3211 /**
3212 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3213 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003214 * <p>NOTE: This should not be used as the primary key of an Intent,
3215 * since it will not result in the app launching with the correct
3216 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003217 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003218 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003219 */
3220 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3221 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3222
3223 /**
3224 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003225 * The activity should be able to play, browse, or manipulate music files
3226 * stored on the device.
3227 * <p>NOTE: This should not be used as the primary key of an Intent,
3228 * since it will not result in the app launching with the correct
3229 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003230 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003231 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003232 */
3233 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3234 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3235
3236 // ---------------------------------------------------------------------
3237 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003238 // Standard extra data keys.
3239
3240 /**
3241 * The initial data to place in a newly created record. Use with
3242 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3243 * fields as would be given to the underlying ContentProvider.insert()
3244 * call.
3245 */
3246 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3247
3248 /**
3249 * A constant CharSequence that is associated with the Intent, used with
3250 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3251 * this may be a styled CharSequence, so you must use
3252 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3253 * retrieve it.
3254 */
3255 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3256
3257 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003258 * A constant String that is associated with the Intent, used with
3259 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3260 * as HTML formatted text. Note that you <em>must</em> also supply
3261 * {@link #EXTRA_TEXT}.
3262 */
3263 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3264
3265 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003266 * A content: URI holding a stream of data associated with the Intent,
3267 * used with {@link #ACTION_SEND} to supply the data being sent.
3268 */
3269 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3270
3271 /**
3272 * A String[] holding e-mail addresses that should be delivered to.
3273 */
3274 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3275
3276 /**
3277 * A String[] holding e-mail addresses that should be carbon copied.
3278 */
3279 public static final String EXTRA_CC = "android.intent.extra.CC";
3280
3281 /**
3282 * A String[] holding e-mail addresses that should be blind carbon copied.
3283 */
3284 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3285
3286 /**
3287 * A constant string holding the desired subject line of a message.
3288 */
3289 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3290
3291 /**
3292 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003293 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003294 */
3295 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3296
3297 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003298 * An Intent[] describing additional, alternate choices you would like shown with
3299 * {@link #ACTION_CHOOSER}.
3300 *
3301 * <p>An app may be capable of providing several different payload types to complete a
3302 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3303 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3304 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3305 * photo data or a hosted link where the photos can be viewed.</p>
3306 *
3307 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3308 * first/primary/preferred intent in the set. Additional intents specified in
3309 * this extra are ordered; by default intents that appear earlier in the array will be
3310 * preferred over intents that appear later in the array as matches for the same
3311 * target component. To alter this preference, a calling app may also supply
3312 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3313 */
3314 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3315
3316 /**
3317 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3318 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3319 *
3320 * <p>An app preparing an action for another app to complete may wish to allow the user to
3321 * disambiguate between several options for completing the action based on the chosen target
3322 * or otherwise refine the action before it is invoked.
3323 * </p>
3324 *
3325 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3326 * <ul>
3327 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3328 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3329 * chosen target beyond the first</li>
3330 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3331 * should fill in and send once the disambiguation is complete</li>
3332 * </ul>
3333 */
3334 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3335 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3336
3337 /**
3338 * A {@link ResultReceiver} used to return data back to the sender.
3339 *
3340 * <p>Used to complete an app-specific
3341 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3342 *
3343 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3344 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3345 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3346 * when the user selects a target component from the chooser. It is up to the recipient
3347 * to send a result to this ResultReceiver to signal that disambiguation is complete
3348 * and that the chooser should invoke the user's choice.</p>
3349 *
3350 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3351 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3352 * to match and fill in the final Intent or ChooserTarget before starting it.
3353 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3354 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3355 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3356 *
3357 * <p>The result code passed to the ResultReceiver should be
3358 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3359 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3360 * the chooser should finish without starting a target.</p>
3361 */
3362 public static final String EXTRA_RESULT_RECEIVER
3363 = "android.intent.extra.RESULT_RECEIVER";
3364
3365 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003366 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003367 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003368 */
3369 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3370
3371 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003372 * A Parcelable[] of {@link Intent} or
3373 * {@link android.content.pm.LabeledIntent} objects as set with
3374 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3375 * a the front of the list of choices, when shown to the user with a
3376 * {@link #ACTION_CHOOSER}.
3377 */
3378 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3379
3380 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003381 * A Bundle forming a mapping of potential target package names to different extras Bundles
3382 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3383 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3384 * be currently installed on the device.
3385 *
3386 * <p>An application may choose to provide alternate extras for the case where a user
3387 * selects an activity from a predetermined set of target packages. If the activity
3388 * the user selects from the chooser belongs to a package with its package name as
3389 * a key in this bundle, the corresponding extras for that package will be merged with
3390 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3391 * extra has the same key as an extra already present in the intent it will overwrite
3392 * the extra from the intent.</p>
3393 *
3394 * <p><em>Examples:</em>
3395 * <ul>
3396 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3397 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3398 * parameters for that target.</li>
3399 * <li>An application may offer additional metadata for known targets of a given intent
3400 * to pass along information only relevant to that target such as account or content
3401 * identifiers already known to that application.</li>
3402 * </ul></p>
3403 */
3404 public static final String EXTRA_REPLACEMENT_EXTRAS =
3405 "android.intent.extra.REPLACEMENT_EXTRAS";
3406
3407 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003408 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3409 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3410 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3411 * {@link ComponentName} of the chosen component.
3412 *
3413 * <p>In some situations this callback may never come, for example if the user abandons
3414 * the chooser, switches to another task or any number of other reasons. Apps should not
3415 * be written assuming that this callback will always occur.</p>
3416 */
3417 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3418 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3419
3420 /**
3421 * The {@link ComponentName} chosen by the user to complete an action.
3422 *
3423 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3424 */
3425 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3426
3427 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003428 * A {@link android.view.KeyEvent} object containing the event that
3429 * triggered the creation of the Intent it is in.
3430 */
3431 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3432
3433 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003434 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3435 * before shutting down.
3436 *
3437 * {@hide}
3438 */
3439 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3440
3441 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003442 * 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 -07003443 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3444 * of restarting the application.
3445 */
3446 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3447
3448 /**
3449 * A String holding the phone number originally entered in
3450 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3451 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3452 */
3453 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003454
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003455 /**
3456 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3457 * intents to supply the uid the package had been assigned. Also an optional
3458 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3459 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3460 * purpose.
3461 */
3462 public static final String EXTRA_UID = "android.intent.extra.UID";
3463
3464 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003465 * @hide String array of package names.
3466 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003467 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003468 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3469
3470 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003471 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3472 * intents to indicate whether this represents a full uninstall (removing
3473 * both the code and its data) or a partial uninstall (leaving its data,
3474 * implying that this is an update).
3475 */
3476 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003477
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003478 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003479 * @hide
3480 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3481 * intents to indicate that at this point the package has been removed for
3482 * all users on the device.
3483 */
3484 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3485 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3486
3487 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003488 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3489 * intents to indicate that this is a replacement of the package, so this
3490 * broadcast will immediately be followed by an add broadcast for a
3491 * different version of the same package.
3492 */
3493 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003494
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003495 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003496 * Used as an int extra field in {@link android.app.AlarmManager} intents
3497 * to tell the application being invoked how many pending alarms are being
3498 * delievered with the intent. For one-shot alarms this will always be 1.
3499 * For recurring alarms, this might be greater than 1 if the device was
3500 * asleep or powered off at the time an earlier alarm would have been
3501 * delivered.
3502 */
3503 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003504
Jacek Surazski86b6c532009-05-13 14:38:28 +02003505 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003506 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3507 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003508 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3509 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003510 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3511 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3512 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003513 */
3514 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3515
3516 /**
3517 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3518 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003519 */
3520 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3521
3522 /**
3523 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3524 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003525 */
3526 public static final int EXTRA_DOCK_STATE_DESK = 1;
3527
3528 /**
3529 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3530 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003531 */
3532 public static final int EXTRA_DOCK_STATE_CAR = 2;
3533
3534 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003535 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3536 * to represent that the phone is in a analog (low end) dock.
3537 */
3538 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3539
3540 /**
3541 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3542 * to represent that the phone is in a digital (high end) dock.
3543 */
3544 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3545
3546 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003547 * Boolean that can be supplied as meta-data with a dock activity, to
3548 * indicate that the dock should take over the home key when it is active.
3549 */
3550 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003551
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003552 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003553 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3554 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003555 */
3556 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3557
3558 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003559 * Used in the extra field in the remote intent. It's astring token passed with the
3560 * remote intent.
3561 */
3562 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3563 "android.intent.extra.remote_intent_token";
3564
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003565 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003566 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003567 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003568 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003569 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003570 "android.intent.extra.changed_component_name";
3571
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003572 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003573 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003574 * and contains a string array of all of the components that have changed. If
3575 * the state of the overall package has changed, then it will contain an entry
3576 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003577 */
3578 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3579 "android.intent.extra.changed_component_name_list";
3580
3581 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003582 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003583 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3584 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003585 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003586 */
3587 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3588 "android.intent.extra.changed_package_list";
3589
3590 /**
3591 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003592 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3593 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003594 * and contains an integer array of uids of all of the components
3595 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003596 */
3597 public static final String EXTRA_CHANGED_UID_LIST =
3598 "android.intent.extra.changed_uid_list";
3599
3600 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003601 * @hide
3602 * Magic extra system code can use when binding, to give a label for
3603 * who it is that has bound to a service. This is an integer giving
3604 * a framework string resource that can be displayed to the user.
3605 */
3606 public static final String EXTRA_CLIENT_LABEL =
3607 "android.intent.extra.client_label";
3608
3609 /**
3610 * @hide
3611 * Magic extra system code can use when binding, to give a PendingIntent object
3612 * that can be launched for the user to disable the system's use of this
3613 * service.
3614 */
3615 public static final String EXTRA_CLIENT_INTENT =
3616 "android.intent.extra.client_intent";
3617
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003618 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003619 * Extra used to indicate that an intent should only return data that is on
3620 * the local device. This is a boolean extra; the default is false. If true,
3621 * an implementation should only allow the user to select data that is
3622 * already on the device, not requiring it be downloaded from a remote
3623 * service when opened.
3624 *
3625 * @see #ACTION_GET_CONTENT
3626 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003627 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003628 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003629 */
3630 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003631 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003632
Amith Yamasani13593602012-03-22 16:16:17 -07003633 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003634 * Extra used to indicate that an intent can allow the user to select and
3635 * return multiple items. This is a boolean extra; the default is false. If
3636 * true, an implementation is allowed to present the user with a UI where
3637 * they can pick multiple items that are all returned to the caller. When
3638 * this happens, they should be returned as the {@link #getClipData()} part
3639 * of the result Intent.
3640 *
3641 * @see #ACTION_GET_CONTENT
3642 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003643 */
3644 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003645 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003646
3647 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003648 * The integer userHandle carried with broadcast intents related to addition, removal and
3649 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3650 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3651 *
Amith Yamasani13593602012-03-22 16:16:17 -07003652 * @hide
3653 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003654 public static final String EXTRA_USER_HANDLE =
3655 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003656
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003657 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003658 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3659 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3660 */
3661 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003662 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003663
3664 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003665 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003666 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3667 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003668 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003669 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3670
3671 /**
3672 * Extra sent in the intent to the BroadcastReceiver that handles
3673 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3674 * the restrictions as key/value pairs.
3675 */
3676 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3677 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003678
Amith Yamasani86118ba2013-03-28 14:33:16 -07003679 /**
3680 * Extra used in the response from a BroadcastReceiver that handles
3681 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3682 */
3683 public static final String EXTRA_RESTRICTIONS_INTENT =
3684 "android.intent.extra.restrictions_intent";
3685
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003686 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003687 * Extra used to communicate a set of acceptable MIME types. The type of the
3688 * extra is {@code String[]}. Values may be a combination of concrete MIME
3689 * types (such as "image/png") and/or partial MIME types (such as
3690 * "audio/*").
3691 *
3692 * @see #ACTION_GET_CONTENT
3693 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003694 */
3695 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3696
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003697 /**
3698 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3699 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003700 * When this is true, hardware devices can use this information to determine that
3701 * they shouldn't do a complete shutdown of their device since this is not a
3702 * complete shutdown down to the kernel, but only user space restarting.
3703 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003704 */
3705 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3706 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3707
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003708 /**
3709 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3710 * user has set their time format preferences to the 24 hour format.
3711 *
3712 * @hide for internal use only.
3713 */
3714 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3715 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3716
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003717 /** {@hide} */
3718 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3719
Santos Cordon15a13782015-03-31 18:32:31 -07003720 /**
3721 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
3722 * activation request.
3723 * TODO: Add information about the structure and response data used with the pending intent.
3724 * @hide
3725 */
3726 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
3727 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
3728
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003729 // ---------------------------------------------------------------------
3730 // ---------------------------------------------------------------------
3731 // Intent flags (see mFlags variable).
3732
Tor Norbyed9273d62013-05-30 15:59:53 -07003733 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003734 @IntDef(flag = true, value = {
3735 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3736 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003737 @Retention(RetentionPolicy.SOURCE)
3738 public @interface GrantUriMode {}
3739
Jeff Sharkey846318a2014-04-04 12:12:41 -07003740 /** @hide */
3741 @IntDef(flag = true, value = {
3742 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3743 @Retention(RetentionPolicy.SOURCE)
3744 public @interface AccessUriMode {}
3745
3746 /**
3747 * Test if given mode flags specify an access mode, which must be at least
3748 * read and/or write.
3749 *
3750 * @hide
3751 */
3752 public static boolean isAccessUriMode(int modeFlags) {
3753 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3754 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3755 }
3756
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003757 /**
3758 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003759 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003760 * specified in its ClipData. When applying to an Intent's ClipData,
3761 * all URIs as well as recursive traversals through data or other ClipData
3762 * in Intent items will be granted; only the grant flags of the top-level
3763 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003764 */
3765 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3766 /**
3767 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003768 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003769 * specified in its ClipData. When applying to an Intent's ClipData,
3770 * all URIs as well as recursive traversals through data or other ClipData
3771 * in Intent items will be granted; only the grant flags of the top-level
3772 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003773 */
3774 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3775 /**
3776 * Can be set by the caller to indicate that this Intent is coming from
3777 * a background operation, not from direct user interaction.
3778 */
3779 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3780 /**
3781 * A flag you can enable for debugging: when set, log messages will be
3782 * printed during the resolution of this intent to show you what has
3783 * been found to create the final resolved list.
3784 */
3785 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003786 /**
3787 * If set, this intent will not match any components in packages that
3788 * are currently stopped. If this is not set, then the default behavior
3789 * is to include such applications in the result.
3790 */
3791 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3792 /**
3793 * If set, this intent will always match any components in packages that
3794 * are currently stopped. This is the default behavior when
3795 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3796 * flags are set, this one wins (it allows overriding of exclude for
3797 * places where the framework may automatically set the exclude flag).
3798 */
3799 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003800
3801 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003802 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003803 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003804 * persisted across device reboots until explicitly revoked with
3805 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3806 * grant for possible persisting; the receiving application must call
3807 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3808 * actually persist.
3809 *
3810 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3811 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3812 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003813 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003814 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003815 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003816
3817 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003818 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3819 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3820 * applies to any URI that is a prefix match against the original granted
3821 * URI. (Without this flag, the URI must match exactly for access to be
3822 * granted.) Another URI is considered a prefix match only when scheme,
3823 * authority, and all path segments defined by the prefix are an exact
3824 * match.
3825 */
3826 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3827
3828 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003829 * If set, the new activity is not kept in the history stack. As soon as
3830 * the user navigates away from it, the activity is finished. This may also
3831 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3832 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07003833 *
3834 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
3835 * is never invoked when the current activity starts a new activity which
3836 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003837 */
3838 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3839 /**
3840 * If set, the activity will not be launched if it is already running
3841 * at the top of the history stack.
3842 */
3843 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3844 /**
3845 * If set, this activity will become the start of a new task on this
3846 * history stack. A task (from the activity that started it to the
3847 * next task activity) defines an atomic group of activities that the
3848 * user can move to. Tasks can be moved to the foreground and background;
3849 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003850 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003851 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3852 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003853 *
3854 * <p>This flag is generally used by activities that want
3855 * to present a "launcher" style behavior: they give the user a list of
3856 * separate things that can be done, which otherwise run completely
3857 * independently of the activity launching them.
3858 *
3859 * <p>When using this flag, if a task is already running for the activity
3860 * you are now starting, then a new activity will not be started; instead,
3861 * the current task will simply be brought to the front of the screen with
3862 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3863 * to disable this behavior.
3864 *
3865 * <p>This flag can not be used when the caller is requesting a result from
3866 * the activity being launched.
3867 */
3868 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3869 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003870 * This flag is used to create a new task and launch an activity into it.
3871 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3872 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3873 * search through existing tasks for ones matching this Intent. Only if no such
3874 * task is found would a new task be created. When paired with
3875 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3876 * the search for a matching task and unconditionally start a new task.
3877 *
3878 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3879 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003880 * top-level application launcher.</strong> Used in conjunction with
3881 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3882 * behavior of bringing an existing task to the foreground. When set,
3883 * a new task is <em>always</em> started to host the Activity for the
3884 * Intent, regardless of whether there is already an existing task running
3885 * the same thing.
3886 *
3887 * <p><strong>Because the default system does not include graphical task management,
3888 * you should not use this flag unless you provide some way for a user to
3889 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003890 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003891 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3892 * creating new document tasks.
3893 *
3894 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003895 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003896 *
Scott Main7aee61f2011-02-08 11:25:01 -08003897 * <p>See
3898 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3899 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003900 *
3901 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3902 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003903 */
3904 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3905 /**
3906 * If set, and the activity being launched is already running in the
3907 * current task, then instead of launching a new instance of that activity,
3908 * all of the other activities on top of it will be closed and this Intent
3909 * will be delivered to the (now on top) old activity as a new Intent.
3910 *
3911 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3912 * If D calls startActivity() with an Intent that resolves to the component
3913 * of activity B, then C and D will be finished and B receive the given
3914 * Intent, resulting in the stack now being: A, B.
3915 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003916 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003917 * either receive the new intent you are starting here in its
3918 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003919 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003920 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3921 * the same intent, then it will be finished and re-created; for all other
3922 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3923 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003924 *
3925 * <p>This launch mode can also be used to good effect in conjunction with
3926 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3927 * of a task, it will bring any currently running instance of that task
3928 * to the foreground, and then clear it to its root state. This is
3929 * especially useful, for example, when launching an activity from the
3930 * notification manager.
3931 *
Scott Main7aee61f2011-02-08 11:25:01 -08003932 * <p>See
3933 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3934 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003935 */
3936 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3937 /**
3938 * If set and this intent is being used to launch a new activity from an
3939 * existing one, then the reply target of the existing activity will be
3940 * transfered to the new activity. This way the new activity can call
3941 * {@link android.app.Activity#setResult} and have that result sent back to
3942 * the reply target of the original activity.
3943 */
3944 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3945 /**
3946 * If set and this intent is being used to launch a new activity from an
3947 * existing one, the current activity will not be counted as the top
3948 * activity for deciding whether the new intent should be delivered to
3949 * the top instead of starting a new one. The previous activity will
3950 * be used as the top, with the assumption being that the current activity
3951 * will finish itself immediately.
3952 */
3953 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3954 /**
3955 * If set, the new activity is not kept in the list of recently launched
3956 * activities.
3957 */
3958 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3959 /**
3960 * This flag is not normally set by application code, but set for you by
3961 * the system as described in the
3962 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3963 * launchMode} documentation for the singleTask mode.
3964 */
3965 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3966 /**
3967 * If set, and this activity is either being started in a new task or
3968 * bringing to the top an existing task, then it will be launched as
3969 * the front door of the task. This will result in the application of
3970 * any affinities needed to have that task in the proper state (either
3971 * moving activities to or from it), or simply resetting that task to
3972 * its initial state if needed.
3973 */
3974 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3975 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003976 * This flag is not normally set by application code, but set for you by
3977 * the system if this activity is being launched from history
3978 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003979 */
3980 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003981 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003982 * @deprecated As of API 21 this performs identically to
3983 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003984 */
3985 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003986 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003987 * This flag is used to open a document into a new task rooted at the activity launched
3988 * by this Intent. Through the use of this flag, or its equivalent attribute,
3989 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00003990 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003991 *
Craig Mautner026596b2014-05-21 15:35:44 -07003992 * <p>The use of the activity attribute form of this,
3993 * {@link android.R.attr#documentLaunchMode}, is
3994 * preferred over the Intent flag described here. The attribute form allows the
3995 * Activity to specify multiple document behavior for all launchers of the Activity
3996 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003997 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003998 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3999 * it is kept after the activity is finished is different than the use of
4000 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4001 * this flag is being used to create a new recents entry, then by default that entry
4002 * will be removed once the activity is finished. You can modify this behavior with
4003 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4004 *
Craig Mautner026596b2014-05-21 15:35:44 -07004005 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4006 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4007 * equivalent of the Activity manifest specifying {@link
4008 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4009 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4010 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004011 *
Craig Mautner026596b2014-05-21 15:35:44 -07004012 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004013 *
Craig Mautner026596b2014-05-21 15:35:44 -07004014 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004015 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4016 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004017 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004018 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004019 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004020 * callback from occurring on the current frontmost activity before it is
4021 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004022 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004023 * <p>Typically, an activity can rely on that callback to indicate that an
4024 * explicit user action has caused their activity to be moved out of the
4025 * foreground. The callback marks an appropriate point in the activity's
4026 * lifecycle for it to dismiss any notifications that it intends to display
4027 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004028 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004029 * <p>If an activity is ever started via any non-user-driven events such as
4030 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4031 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004032 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004033 */
4034 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004035 /**
4036 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4037 * this flag will cause the launched activity to be brought to the front of its
4038 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004039 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004040 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4041 * If D calls startActivity() with an Intent that resolves to the component
4042 * of activity B, then B will be brought to the front of the history stack,
4043 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004044 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004045 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004046 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004047 */
4048 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004049 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004050 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4051 * this flag will prevent the system from applying an activity transition
4052 * animation to go to the next activity state. This doesn't mean an
4053 * animation will never run -- if another activity change happens that doesn't
4054 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004055 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004056 * when you are going to do a series of activity operations but the
4057 * animation seen by the user shouldn't be driven by the first activity
4058 * change but rather a later one.
4059 */
4060 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4061 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004062 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4063 * this flag will cause any existing task that would be associated with the
4064 * activity to be cleared before the activity is started. That is, the activity
4065 * becomes the new root of an otherwise empty task, and any old activities
4066 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4067 */
4068 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4069 /**
4070 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4071 * this flag will cause a newly launching task to be placed on top of the current
4072 * home activity task (if there is one). That is, pressing back from the task
4073 * will always return the user to home even if that was not the last activity they
4074 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4075 */
4076 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4077 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004078 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4079 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004080 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004081 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004082 * this flag. When set and the task's activity is finished, the recents
4083 * entry will remain in the interface for the user to re-launch it, like a
4084 * recents entry for a top-level application.
4085 * <p>
4086 * The receiving activity can override this request with
4087 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4088 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004089 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004090 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004091 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004092
4093 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004094 * If set, when sending a broadcast only registered receivers will be
4095 * called -- no BroadcastReceiver components will be launched.
4096 */
4097 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004098 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004099 * If set, when sending a broadcast the new broadcast will replace
4100 * any existing pending broadcast that matches it. Matching is defined
4101 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4102 * true for the intents of the two broadcasts. When a match is found,
4103 * the new broadcast (and receivers associated with it) will replace the
4104 * existing one in the pending broadcast list, remaining at the same
4105 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004106 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004107 * <p>This flag is most typically used with sticky broadcasts, which
4108 * only care about delivering the most recent values of the broadcast
4109 * to their receivers.
4110 */
4111 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4112 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004113 * If set, when sending a broadcast the recipient is allowed to run at
4114 * foreground priority, with a shorter timeout interval. During normal
4115 * broadcasts the receivers are not automatically hoisted out of the
4116 * background priority class.
4117 */
4118 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4119 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004120 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4121 * They can still propagate results through to later receivers, but they can not prevent
4122 * later receivers from seeing the broadcast.
4123 */
4124 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4125 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004126 * If set, when sending a broadcast <i>before boot has completed</i> only
4127 * registered receivers will be called -- no BroadcastReceiver components
4128 * will be launched. Sticky intent state will be recorded properly even
4129 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4130 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004131 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004132 * <p>This flag is only for use by system sevices as a convenience to
4133 * avoid having to implement a more complex mechanism around detection
4134 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004135 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004136 * @hide
4137 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004138 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004139 /**
4140 * Set when this broadcast is for a boot upgrade, a special mode that
4141 * allows the broadcast to be sent before the system is ready and launches
4142 * the app process with no providers running in it.
4143 * @hide
4144 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004145 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004146
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004147 /**
4148 * @hide Flags that can't be changed with PendingIntent.
4149 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004150 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4151 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4152 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004153
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004155 // ---------------------------------------------------------------------
4156 // toUri() and parseUri() options.
4157
4158 /**
4159 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4160 * always has the "intent:" scheme. This syntax can be used when you want
4161 * to later disambiguate between URIs that are intended to describe an
4162 * Intent vs. all others that should be treated as raw URIs. When used
4163 * with {@link #parseUri}, any other scheme will result in a generic
4164 * VIEW action for that raw URI.
4165 */
4166 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004167
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004168 /**
4169 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4170 * always has the "android-app:" scheme. This is a variation of
4171 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4172 * http/https URI being delivered to a specific package name. The format
4173 * is:
4174 *
4175 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004176 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004177 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004178 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4179 * you must also include a scheme; including a path also requires both a host and a scheme.
4180 * The final #Intent; fragment can be used without a scheme, host, or path.
4181 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004182 * used with intents that have a {@link #setSelector}, since the base intent
4183 * will always have an explicit package name.</p>
4184 *
4185 * <p>Some examples of how this scheme maps to Intent objects:</p>
4186 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4187 * <colgroup align="left" />
4188 * <colgroup align="left" />
4189 * <thead>
4190 * <tr><th>URI</th> <th>Intent</th></tr>
4191 * </thead>
4192 *
4193 * <tbody>
4194 * <tr><td><code>android-app://com.example.app</code></td>
4195 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4196 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4197 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4198 * </table></td>
4199 * </tr>
4200 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4201 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4202 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4203 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4204 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4205 * </table></td>
4206 * </tr>
4207 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4208 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4209 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4210 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4211 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4212 * </table></td>
4213 * </tr>
4214 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4215 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4216 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4217 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4218 * </table></td>
4219 * </tr>
4220 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4221 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4222 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4223 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4224 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4225 * </table></td>
4226 * </tr>
4227 * <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>
4228 * <td><table border="" style="margin:0" >
4229 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4230 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4231 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4232 * </table></td>
4233 * </tr>
4234 * </tbody>
4235 * </table>
4236 */
4237 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4238
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004239 /**
4240 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4241 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4242 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4243 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4244 * generated Intent can not cause unexpected data access to happen.
4245 *
4246 * <p>If you do not trust the source of the URI being parsed, you should still do further
4247 * processing to protect yourself from it. In particular, when using it to start an
4248 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4249 * that can handle it.</p>
4250 */
4251 public static final int URI_ALLOW_UNSAFE = 1<<2;
4252
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004253 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004254
4255 private String mAction;
4256 private Uri mData;
4257 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004258 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004259 private ComponentName mComponent;
4260 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004261 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004262 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004263 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004264 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004265 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004266 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004267
4268 // ---------------------------------------------------------------------
4269
4270 /**
4271 * Create an empty intent.
4272 */
4273 public Intent() {
4274 }
4275
4276 /**
4277 * Copy constructor.
4278 */
4279 public Intent(Intent o) {
4280 this.mAction = o.mAction;
4281 this.mData = o.mData;
4282 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004283 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004284 this.mComponent = o.mComponent;
4285 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004286 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004287 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004288 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004289 }
4290 if (o.mExtras != null) {
4291 this.mExtras = new Bundle(o.mExtras);
4292 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004293 if (o.mSourceBounds != null) {
4294 this.mSourceBounds = new Rect(o.mSourceBounds);
4295 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004296 if (o.mSelector != null) {
4297 this.mSelector = new Intent(o.mSelector);
4298 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004299 if (o.mClipData != null) {
4300 this.mClipData = new ClipData(o.mClipData);
4301 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004302 }
4303
4304 @Override
4305 public Object clone() {
4306 return new Intent(this);
4307 }
4308
4309 private Intent(Intent o, boolean all) {
4310 this.mAction = o.mAction;
4311 this.mData = o.mData;
4312 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004313 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004314 this.mComponent = o.mComponent;
4315 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004316 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004317 }
4318 }
4319
4320 /**
4321 * Make a clone of only the parts of the Intent that are relevant for
4322 * filter matching: the action, data, type, component, and categories.
4323 */
4324 public Intent cloneFilter() {
4325 return new Intent(this, false);
4326 }
4327
4328 /**
4329 * Create an intent with a given action. All other fields (data, type,
4330 * class) are null. Note that the action <em>must</em> be in a
4331 * namespace because Intents are used globally in the system -- for
4332 * example the system VIEW action is android.intent.action.VIEW; an
4333 * application's custom action would be something like
4334 * com.google.app.myapp.CUSTOM_ACTION.
4335 *
4336 * @param action The Intent action, such as ACTION_VIEW.
4337 */
4338 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004339 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004340 }
4341
4342 /**
4343 * Create an intent with a given action and for a given data url. Note
4344 * that the action <em>must</em> be in a namespace because Intents are
4345 * used globally in the system -- for example the system VIEW action is
4346 * android.intent.action.VIEW; an application's custom action would be
4347 * something like com.google.app.myapp.CUSTOM_ACTION.
4348 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004349 * <p><em>Note: scheme and host name matching in the Android framework is
4350 * case-sensitive, unlike the formal RFC. As a result,
4351 * you should always ensure that you write your Uri with these elements
4352 * using lower case letters, and normalize any Uris you receive from
4353 * outside of Android to ensure the scheme and host is lower case.</em></p>
4354 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004355 * @param action The Intent action, such as ACTION_VIEW.
4356 * @param uri The Intent data URI.
4357 */
4358 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004359 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004360 mData = uri;
4361 }
4362
4363 /**
4364 * Create an intent for a specific component. All other fields (action, data,
4365 * type, class) are null, though they can be modified later with explicit
4366 * calls. This provides a convenient way to create an intent that is
4367 * intended to execute a hard-coded class name, rather than relying on the
4368 * system to find an appropriate class for you; see {@link #setComponent}
4369 * for more information on the repercussions of this.
4370 *
4371 * @param packageContext A Context of the application package implementing
4372 * this class.
4373 * @param cls The component class that is to be used for the intent.
4374 *
4375 * @see #setClass
4376 * @see #setComponent
4377 * @see #Intent(String, android.net.Uri , Context, Class)
4378 */
4379 public Intent(Context packageContext, Class<?> cls) {
4380 mComponent = new ComponentName(packageContext, cls);
4381 }
4382
4383 /**
4384 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004385 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004386 * construct the Intent and then calling {@link #setClass} to set its
4387 * class.
4388 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004389 * <p><em>Note: scheme and host name matching in the Android framework is
4390 * case-sensitive, unlike the formal RFC. As a result,
4391 * you should always ensure that you write your Uri with these elements
4392 * using lower case letters, and normalize any Uris you receive from
4393 * outside of Android to ensure the scheme and host is lower case.</em></p>
4394 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004395 * @param action The Intent action, such as ACTION_VIEW.
4396 * @param uri The Intent data URI.
4397 * @param packageContext A Context of the application package implementing
4398 * this class.
4399 * @param cls The component class that is to be used for the intent.
4400 *
4401 * @see #Intent(String, android.net.Uri)
4402 * @see #Intent(Context, Class)
4403 * @see #setClass
4404 * @see #setComponent
4405 */
4406 public Intent(String action, Uri uri,
4407 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004408 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004409 mData = uri;
4410 mComponent = new ComponentName(packageContext, cls);
4411 }
4412
4413 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004414 * Create an intent to launch the main (root) activity of a task. This
4415 * is the Intent that is started when the application's is launched from
4416 * Home. For anything else that wants to launch an application in the
4417 * same way, it is important that they use an Intent structured the same
4418 * way, and can use this function to ensure this is the case.
4419 *
4420 * <p>The returned Intent has the given Activity component as its explicit
4421 * component, {@link #ACTION_MAIN} as its action, and includes the
4422 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4423 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4424 * to do that through {@link #addFlags(int)} on the returned Intent.
4425 *
4426 * @param mainActivity The main activity component that this Intent will
4427 * launch.
4428 * @return Returns a newly created Intent that can be used to launch the
4429 * activity as a main application entry.
4430 *
4431 * @see #setClass
4432 * @see #setComponent
4433 */
4434 public static Intent makeMainActivity(ComponentName mainActivity) {
4435 Intent intent = new Intent(ACTION_MAIN);
4436 intent.setComponent(mainActivity);
4437 intent.addCategory(CATEGORY_LAUNCHER);
4438 return intent;
4439 }
4440
4441 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004442 * Make an Intent for the main activity of an application, without
4443 * specifying a specific activity to run but giving a selector to find
4444 * the activity. This results in a final Intent that is structured
4445 * the same as when the application is launched from
4446 * Home. For anything else that wants to launch an application in the
4447 * same way, it is important that they use an Intent structured the same
4448 * way, and can use this function to ensure this is the case.
4449 *
4450 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4451 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4452 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4453 * to do that through {@link #addFlags(int)} on the returned Intent.
4454 *
4455 * @param selectorAction The action name of the Intent's selector.
4456 * @param selectorCategory The name of a category to add to the Intent's
4457 * selector.
4458 * @return Returns a newly created Intent that can be used to launch the
4459 * activity as a main application entry.
4460 *
4461 * @see #setSelector(Intent)
4462 */
4463 public static Intent makeMainSelectorActivity(String selectorAction,
4464 String selectorCategory) {
4465 Intent intent = new Intent(ACTION_MAIN);
4466 intent.addCategory(CATEGORY_LAUNCHER);
4467 Intent selector = new Intent();
4468 selector.setAction(selectorAction);
4469 selector.addCategory(selectorCategory);
4470 intent.setSelector(selector);
4471 return intent;
4472 }
4473
4474 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004475 * Make an Intent that can be used to re-launch an application's task
4476 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4477 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4478 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4479 *
4480 * @param mainActivity The activity component that is the root of the
4481 * task; this is the activity that has been published in the application's
4482 * manifest as the main launcher icon.
4483 *
4484 * @return Returns a newly created Intent that can be used to relaunch the
4485 * activity's task in its root state.
4486 */
4487 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4488 Intent intent = makeMainActivity(mainActivity);
4489 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4490 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4491 return intent;
4492 }
4493
4494 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004495 * Call {@link #parseUri} with 0 flags.
4496 * @deprecated Use {@link #parseUri} instead.
4497 */
4498 @Deprecated
4499 public static Intent getIntent(String uri) throws URISyntaxException {
4500 return parseUri(uri, 0);
4501 }
Tom Taylord4a47292009-12-21 13:59:18 -08004502
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004503 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004504 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004505 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004506 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004507 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004508 *
4509 * <p>The URI given here must not be relative -- that is, it must include
4510 * the scheme and full path.
4511 *
4512 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004513 * @param flags Additional processing flags. Either 0,
4514 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004515 *
4516 * @return Intent The newly created Intent object.
4517 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004518 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4519 * it bad (as parsed by the Uri class) or the Intent data within the
4520 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004521 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004522 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004523 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004524 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004525 int i = 0;
4526 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004527 final boolean androidApp = uri.startsWith("android-app:");
4528
4529 // Validate intent scheme if requested.
4530 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4531 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004532 Intent intent = new Intent(ACTION_VIEW);
4533 try {
4534 intent.setData(Uri.parse(uri));
4535 } catch (IllegalArgumentException e) {
4536 throw new URISyntaxException(uri, e.getMessage());
4537 }
4538 return intent;
4539 }
4540 }
Tom Taylord4a47292009-12-21 13:59:18 -08004541
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004542 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004543 // simple case
4544 if (i == -1) {
4545 if (!androidApp) {
4546 return new Intent(ACTION_VIEW, Uri.parse(uri));
4547 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004548
4549 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004550 } else if (!uri.startsWith("#Intent;", i)) {
4551 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004552 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004553 } else {
4554 i = -1;
4555 }
4556 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004557
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004558 // new format
4559 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004560 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004561 boolean explicitAction = false;
4562 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004563
4564 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004565 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004566 String data;
4567 if (i >= 0) {
4568 data = uri.substring(0, i);
4569 i += 8; // length of "#Intent;"
4570 } else {
4571 data = uri;
4572 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004573
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004574 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004575 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004576 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004577 if (eq < 0) eq = i-1;
4578 int semi = uri.indexOf(';', i);
4579 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004580
4581 // action
4582 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004583 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004584 if (!inSelector) {
4585 explicitAction = true;
4586 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004587 }
4588
4589 // categories
4590 else if (uri.startsWith("category=", i)) {
4591 intent.addCategory(value);
4592 }
4593
4594 // type
4595 else if (uri.startsWith("type=", i)) {
4596 intent.mType = value;
4597 }
4598
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004599 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004600 else if (uri.startsWith("launchFlags=", i)) {
4601 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004602 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4603 intent.mFlags &= ~IMMUTABLE_FLAGS;
4604 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004605 }
4606
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004607 // package
4608 else if (uri.startsWith("package=", i)) {
4609 intent.mPackage = value;
4610 }
4611
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004612 // component
4613 else if (uri.startsWith("component=", i)) {
4614 intent.mComponent = ComponentName.unflattenFromString(value);
4615 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004616
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004617 // scheme
4618 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004619 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004620 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004621 } else {
4622 scheme = value;
4623 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004624 }
4625
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004626 // source bounds
4627 else if (uri.startsWith("sourceBounds=", i)) {
4628 intent.mSourceBounds = Rect.unflattenFromString(value);
4629 }
4630
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004631 // selector
4632 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4633 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004634 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004635 }
4636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004637 // extra
4638 else {
4639 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004640 // create Bundle if it doesn't already exist
4641 if (intent.mExtras == null) intent.mExtras = new Bundle();
4642 Bundle b = intent.mExtras;
4643 // add EXTRA
4644 if (uri.startsWith("S.", i)) b.putString(key, value);
4645 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4646 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4647 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4648 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4649 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4650 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4651 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4652 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4653 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4654 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004656 // move to the next item
4657 i = semi + 1;
4658 }
4659
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004660 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004661 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004662 if (baseIntent.mPackage == null) {
4663 baseIntent.setSelector(intent);
4664 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004665 intent = baseIntent;
4666 }
4667
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004668 if (data != null) {
4669 if (data.startsWith("intent:")) {
4670 data = data.substring(7);
4671 if (scheme != null) {
4672 data = scheme + ':' + data;
4673 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004674 } else if (data.startsWith("android-app:")) {
4675 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
4676 // Correctly formed android-app, first part is package name.
4677 int end = data.indexOf('/', 14);
4678 if (end < 0) {
4679 // All we have is a package name.
4680 intent.mPackage = data.substring(14);
4681 if (!explicitAction) {
4682 intent.setAction(ACTION_MAIN);
4683 }
4684 data = "";
4685 } else {
4686 // Target the Intent at the given package name always.
4687 String authority = null;
4688 intent.mPackage = data.substring(14, end);
4689 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004690 if ((end+1) < data.length()) {
4691 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
4692 // Found a scheme, remember it.
4693 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004694 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004695 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
4696 // Found a authority, remember it.
4697 authority = data.substring(end+1, newEnd);
4698 end = newEnd;
4699 }
4700 } else {
4701 // All we have is a scheme.
4702 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004703 }
4704 }
4705 if (scheme == null) {
4706 // If there was no scheme, then this just targets the package.
4707 if (!explicitAction) {
4708 intent.setAction(ACTION_MAIN);
4709 }
4710 data = "";
4711 } else if (authority == null) {
4712 data = scheme + ":";
4713 } else {
4714 data = scheme + "://" + authority + data.substring(end);
4715 }
4716 }
4717 } else {
4718 data = "";
4719 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004720 }
Tom Taylord4a47292009-12-21 13:59:18 -08004721
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004722 if (data.length() > 0) {
4723 try {
4724 intent.mData = Uri.parse(data);
4725 } catch (IllegalArgumentException e) {
4726 throw new URISyntaxException(uri, e.getMessage());
4727 }
4728 }
4729 }
Tom Taylord4a47292009-12-21 13:59:18 -08004730
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004731 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004732
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004733 } catch (IndexOutOfBoundsException e) {
4734 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4735 }
4736 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004737
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004738 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004739 return getIntentOld(uri, 0);
4740 }
4741
4742 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004743 Intent intent;
4744
4745 int i = uri.lastIndexOf('#');
4746 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004747 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004748 final int intentFragmentStart = i;
4749 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004750
4751 i++;
4752
4753 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004754 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004755 i += 7;
4756 int j = uri.indexOf(')', i);
4757 action = uri.substring(i, j);
4758 i = j + 1;
4759 }
4760
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004761 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004762
4763 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004764 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004765 i += 11;
4766 int j = uri.indexOf(')', i);
4767 while (i < j) {
4768 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004769 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004770 if (i < sep) {
4771 intent.addCategory(uri.substring(i, sep));
4772 }
4773 i = sep + 1;
4774 }
4775 i = j + 1;
4776 }
4777
4778 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004779 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004780 i += 5;
4781 int j = uri.indexOf(')', i);
4782 intent.mType = uri.substring(i, j);
4783 i = j + 1;
4784 }
4785
4786 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004787 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004788 i += 12;
4789 int j = uri.indexOf(')', i);
4790 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004791 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4792 intent.mFlags &= ~IMMUTABLE_FLAGS;
4793 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004794 i = j + 1;
4795 }
4796
4797 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004798 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004799 i += 10;
4800 int j = uri.indexOf(')', i);
4801 int sep = uri.indexOf('!', i);
4802 if (sep >= 0 && sep < j) {
4803 String pkg = uri.substring(i, sep);
4804 String cls = uri.substring(sep + 1, j);
4805 intent.mComponent = new ComponentName(pkg, cls);
4806 }
4807 i = j + 1;
4808 }
4809
4810 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004811 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004812 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004813
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004814 final int closeParen = uri.indexOf(')', i);
4815 if (closeParen == -1) throw new URISyntaxException(uri,
4816 "EXTRA missing trailing ')'", i);
4817
4818 while (i < closeParen) {
4819 // fetch the key value
4820 int j = uri.indexOf('=', i);
4821 if (j <= i + 1 || i >= closeParen) {
4822 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4823 }
4824 char type = uri.charAt(i);
4825 i++;
4826 String key = uri.substring(i, j);
4827 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004828
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004829 // get type-value
4830 j = uri.indexOf('!', i);
4831 if (j == -1 || j >= closeParen) j = closeParen;
4832 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4833 String value = uri.substring(i, j);
4834 i = j;
4835
4836 // create Bundle if it doesn't already exist
4837 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004838
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004839 // add item to bundle
4840 try {
4841 switch (type) {
4842 case 'S':
4843 intent.mExtras.putString(key, Uri.decode(value));
4844 break;
4845 case 'B':
4846 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4847 break;
4848 case 'b':
4849 intent.mExtras.putByte(key, Byte.parseByte(value));
4850 break;
4851 case 'c':
4852 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4853 break;
4854 case 'd':
4855 intent.mExtras.putDouble(key, Double.parseDouble(value));
4856 break;
4857 case 'f':
4858 intent.mExtras.putFloat(key, Float.parseFloat(value));
4859 break;
4860 case 'i':
4861 intent.mExtras.putInt(key, Integer.parseInt(value));
4862 break;
4863 case 'l':
4864 intent.mExtras.putLong(key, Long.parseLong(value));
4865 break;
4866 case 's':
4867 intent.mExtras.putShort(key, Short.parseShort(value));
4868 break;
4869 default:
4870 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4871 }
4872 } catch (NumberFormatException e) {
4873 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4874 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004875
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004876 char ch = uri.charAt(i);
4877 if (ch == ')') break;
4878 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4879 i++;
4880 }
4881 }
4882
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004883 if (isIntentFragment) {
4884 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4885 } else {
4886 intent.mData = Uri.parse(uri);
4887 }
Tom Taylord4a47292009-12-21 13:59:18 -08004888
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004889 if (intent.mAction == null) {
4890 // By default, if no action is specified, then use VIEW.
4891 intent.mAction = ACTION_VIEW;
4892 }
4893
4894 } else {
4895 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4896 }
4897
4898 return intent;
4899 }
4900
4901 /**
4902 * Retrieve the general action to be performed, such as
4903 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4904 * the information in the intent should be interpreted -- most importantly,
4905 * what to do with the data returned by {@link #getData}.
4906 *
4907 * @return The action of this intent or null if none is specified.
4908 *
4909 * @see #setAction
4910 */
4911 public String getAction() {
4912 return mAction;
4913 }
4914
4915 /**
4916 * Retrieve data this intent is operating on. This URI specifies the name
4917 * of the data; often it uses the content: scheme, specifying data in a
4918 * content provider. Other schemes may be handled by specific activities,
4919 * such as http: by the web browser.
4920 *
4921 * @return The URI of the data this intent is targeting or null.
4922 *
4923 * @see #getScheme
4924 * @see #setData
4925 */
4926 public Uri getData() {
4927 return mData;
4928 }
4929
4930 /**
4931 * The same as {@link #getData()}, but returns the URI as an encoded
4932 * String.
4933 */
4934 public String getDataString() {
4935 return mData != null ? mData.toString() : null;
4936 }
4937
4938 /**
4939 * Return the scheme portion of the intent's data. If the data is null or
4940 * does not include a scheme, null is returned. Otherwise, the scheme
4941 * prefix without the final ':' is returned, i.e. "http".
4942 *
4943 * <p>This is the same as calling getData().getScheme() (and checking for
4944 * null data).
4945 *
4946 * @return The scheme of this intent.
4947 *
4948 * @see #getData
4949 */
4950 public String getScheme() {
4951 return mData != null ? mData.getScheme() : null;
4952 }
4953
4954 /**
4955 * Retrieve any explicit MIME type included in the intent. This is usually
4956 * null, as the type is determined by the intent data.
4957 *
4958 * @return If a type was manually set, it is returned; else null is
4959 * returned.
4960 *
4961 * @see #resolveType(ContentResolver)
4962 * @see #setType
4963 */
4964 public String getType() {
4965 return mType;
4966 }
4967
4968 /**
4969 * Return the MIME data type of this intent. If the type field is
4970 * explicitly set, that is simply returned. Otherwise, if the data is set,
4971 * the type of that data is returned. If neither fields are set, a null is
4972 * returned.
4973 *
4974 * @return The MIME type of this intent.
4975 *
4976 * @see #getType
4977 * @see #resolveType(ContentResolver)
4978 */
4979 public String resolveType(Context context) {
4980 return resolveType(context.getContentResolver());
4981 }
4982
4983 /**
4984 * Return the MIME data type of this intent. If the type field is
4985 * explicitly set, that is simply returned. Otherwise, if the data is set,
4986 * the type of that data is returned. If neither fields are set, a null is
4987 * returned.
4988 *
4989 * @param resolver A ContentResolver that can be used to determine the MIME
4990 * type of the intent's data.
4991 *
4992 * @return The MIME type of this intent.
4993 *
4994 * @see #getType
4995 * @see #resolveType(Context)
4996 */
4997 public String resolveType(ContentResolver resolver) {
4998 if (mType != null) {
4999 return mType;
5000 }
5001 if (mData != null) {
5002 if ("content".equals(mData.getScheme())) {
5003 return resolver.getType(mData);
5004 }
5005 }
5006 return null;
5007 }
5008
5009 /**
5010 * Return the MIME data type of this intent, only if it will be needed for
5011 * intent resolution. This is not generally useful for application code;
5012 * it is used by the frameworks for communicating with back-end system
5013 * services.
5014 *
5015 * @param resolver A ContentResolver that can be used to determine the MIME
5016 * type of the intent's data.
5017 *
5018 * @return The MIME type of this intent, or null if it is unknown or not
5019 * needed.
5020 */
5021 public String resolveTypeIfNeeded(ContentResolver resolver) {
5022 if (mComponent != null) {
5023 return mType;
5024 }
5025 return resolveType(resolver);
5026 }
5027
5028 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005029 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005030 *
5031 * @param category The category to check.
5032 *
5033 * @return boolean True if the intent contains the category, else false.
5034 *
5035 * @see #getCategories
5036 * @see #addCategory
5037 */
5038 public boolean hasCategory(String category) {
5039 return mCategories != null && mCategories.contains(category);
5040 }
5041
5042 /**
5043 * Return the set of all categories in the intent. If there are no categories,
5044 * returns NULL.
5045 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005046 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005047 *
5048 * @see #hasCategory
5049 * @see #addCategory
5050 */
5051 public Set<String> getCategories() {
5052 return mCategories;
5053 }
5054
5055 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005056 * Return the specific selector associated with this Intent. If there is
5057 * none, returns null. See {@link #setSelector} for more information.
5058 *
5059 * @see #setSelector
5060 */
5061 public Intent getSelector() {
5062 return mSelector;
5063 }
5064
5065 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005066 * Return the {@link ClipData} associated with this Intent. If there is
5067 * none, returns null. See {@link #setClipData} for more information.
5068 *
John Spurlock125d1332013-11-25 11:58:37 -05005069 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005070 */
5071 public ClipData getClipData() {
5072 return mClipData;
5073 }
5074
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005075 /** @hide */
5076 public int getContentUserHint() {
5077 return mContentUserHint;
5078 }
5079
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005080 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081 * Sets the ClassLoader that will be used when unmarshalling
5082 * any Parcelable values from the extras of this Intent.
5083 *
5084 * @param loader a ClassLoader, or null to use the default loader
5085 * at the time of unmarshalling.
5086 */
5087 public void setExtrasClassLoader(ClassLoader loader) {
5088 if (mExtras != null) {
5089 mExtras.setClassLoader(loader);
5090 }
5091 }
5092
5093 /**
5094 * Returns true if an extra value is associated with the given name.
5095 * @param name the extra's name
5096 * @return true if the given extra is present.
5097 */
5098 public boolean hasExtra(String name) {
5099 return mExtras != null && mExtras.containsKey(name);
5100 }
5101
5102 /**
5103 * Returns true if the Intent's extras contain a parcelled file descriptor.
5104 * @return true if the Intent contains a parcelled file descriptor.
5105 */
5106 public boolean hasFileDescriptors() {
5107 return mExtras != null && mExtras.hasFileDescriptors();
5108 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005109
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04005110 /** @hide */
5111 public void setAllowFds(boolean allowFds) {
5112 if (mExtras != null) {
5113 mExtras.setAllowFds(allowFds);
5114 }
5115 }
5116
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005117 /**
5118 * Retrieve extended data from the intent.
5119 *
5120 * @param name The name of the desired item.
5121 *
5122 * @return the value of an item that previously added with putExtra()
5123 * or null if none was found.
5124 *
5125 * @deprecated
5126 * @hide
5127 */
5128 @Deprecated
5129 public Object getExtra(String name) {
5130 return getExtra(name, null);
5131 }
5132
5133 /**
5134 * Retrieve extended data from the intent.
5135 *
5136 * @param name The name of the desired item.
5137 * @param defaultValue the value to be returned if no value of the desired
5138 * type is stored with the given name.
5139 *
5140 * @return the value of an item that previously added with putExtra()
5141 * or the default value if none was found.
5142 *
5143 * @see #putExtra(String, boolean)
5144 */
5145 public boolean getBooleanExtra(String name, boolean defaultValue) {
5146 return mExtras == null ? defaultValue :
5147 mExtras.getBoolean(name, defaultValue);
5148 }
5149
5150 /**
5151 * Retrieve extended data from the intent.
5152 *
5153 * @param name The name of the desired item.
5154 * @param defaultValue the value to be returned if no value of the desired
5155 * type is stored with the given name.
5156 *
5157 * @return the value of an item that previously added with putExtra()
5158 * or the default value if none was found.
5159 *
5160 * @see #putExtra(String, byte)
5161 */
5162 public byte getByteExtra(String name, byte defaultValue) {
5163 return mExtras == null ? defaultValue :
5164 mExtras.getByte(name, defaultValue);
5165 }
5166
5167 /**
5168 * Retrieve extended data from the intent.
5169 *
5170 * @param name The name of the desired item.
5171 * @param defaultValue the value to be returned if no value of the desired
5172 * type is stored with the given name.
5173 *
5174 * @return the value of an item that previously added with putExtra()
5175 * or the default value if none was found.
5176 *
5177 * @see #putExtra(String, short)
5178 */
5179 public short getShortExtra(String name, short defaultValue) {
5180 return mExtras == null ? defaultValue :
5181 mExtras.getShort(name, defaultValue);
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, char)
5195 */
5196 public char getCharExtra(String name, char defaultValue) {
5197 return mExtras == null ? defaultValue :
5198 mExtras.getChar(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, int)
5212 */
5213 public int getIntExtra(String name, int defaultValue) {
5214 return mExtras == null ? defaultValue :
5215 mExtras.getInt(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, long)
5229 */
5230 public long getLongExtra(String name, long defaultValue) {
5231 return mExtras == null ? defaultValue :
5232 mExtras.getLong(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 no such item is present
5244 *
5245 * @see #putExtra(String, float)
5246 */
5247 public float getFloatExtra(String name, float defaultValue) {
5248 return mExtras == null ? defaultValue :
5249 mExtras.getFloat(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, double)
5263 */
5264 public double getDoubleExtra(String name, double defaultValue) {
5265 return mExtras == null ? defaultValue :
5266 mExtras.getDouble(name, defaultValue);
5267 }
5268
5269 /**
5270 * Retrieve extended data from the intent.
5271 *
5272 * @param name The name of the desired item.
5273 *
5274 * @return the value of an item that previously added with putExtra()
5275 * or null if no String value was found.
5276 *
5277 * @see #putExtra(String, String)
5278 */
5279 public String getStringExtra(String name) {
5280 return mExtras == null ? null : mExtras.getString(name);
5281 }
5282
5283 /**
5284 * Retrieve extended data from the intent.
5285 *
5286 * @param name The name of the desired item.
5287 *
5288 * @return the value of an item that previously added with putExtra()
5289 * or null if no CharSequence value was found.
5290 *
5291 * @see #putExtra(String, CharSequence)
5292 */
5293 public CharSequence getCharSequenceExtra(String name) {
5294 return mExtras == null ? null : mExtras.getCharSequence(name);
5295 }
5296
5297 /**
5298 * Retrieve extended data from the intent.
5299 *
5300 * @param name The name of the desired item.
5301 *
5302 * @return the value of an item that previously added with putExtra()
5303 * or null if no Parcelable value was found.
5304 *
5305 * @see #putExtra(String, Parcelable)
5306 */
5307 public <T extends Parcelable> T getParcelableExtra(String name) {
5308 return mExtras == null ? null : mExtras.<T>getParcelable(name);
5309 }
5310
5311 /**
5312 * Retrieve extended data from the intent.
5313 *
5314 * @param name The name of the desired item.
5315 *
5316 * @return the value of an item that previously added with putExtra()
5317 * or null if no Parcelable[] value was found.
5318 *
5319 * @see #putExtra(String, Parcelable[])
5320 */
5321 public Parcelable[] getParcelableArrayExtra(String name) {
5322 return mExtras == null ? null : mExtras.getParcelableArray(name);
5323 }
5324
5325 /**
5326 * Retrieve extended data from the intent.
5327 *
5328 * @param name The name of the desired item.
5329 *
5330 * @return the value of an item that previously added with putExtra()
5331 * or null if no ArrayList<Parcelable> value was found.
5332 *
5333 * @see #putParcelableArrayListExtra(String, ArrayList)
5334 */
5335 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
5336 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
5337 }
5338
5339 /**
5340 * Retrieve extended data from the intent.
5341 *
5342 * @param name The name of the desired item.
5343 *
5344 * @return the value of an item that previously added with putExtra()
5345 * or null if no Serializable value was found.
5346 *
5347 * @see #putExtra(String, Serializable)
5348 */
5349 public Serializable getSerializableExtra(String name) {
5350 return mExtras == null ? null : mExtras.getSerializable(name);
5351 }
5352
5353 /**
5354 * Retrieve extended data from the intent.
5355 *
5356 * @param name The name of the desired item.
5357 *
5358 * @return the value of an item that previously added with putExtra()
5359 * or null if no ArrayList<Integer> value was found.
5360 *
5361 * @see #putIntegerArrayListExtra(String, ArrayList)
5362 */
5363 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
5364 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
5365 }
5366
5367 /**
5368 * Retrieve extended data from the intent.
5369 *
5370 * @param name The name of the desired item.
5371 *
5372 * @return the value of an item that previously added with putExtra()
5373 * or null if no ArrayList<String> value was found.
5374 *
5375 * @see #putStringArrayListExtra(String, ArrayList)
5376 */
5377 public ArrayList<String> getStringArrayListExtra(String name) {
5378 return mExtras == null ? null : mExtras.getStringArrayList(name);
5379 }
5380
5381 /**
5382 * Retrieve extended data from the intent.
5383 *
5384 * @param name The name of the desired item.
5385 *
5386 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005387 * or null if no ArrayList<CharSequence> value was found.
5388 *
5389 * @see #putCharSequenceArrayListExtra(String, ArrayList)
5390 */
5391 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
5392 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5393 }
5394
5395 /**
5396 * Retrieve extended data from the intent.
5397 *
5398 * @param name The name of the desired item.
5399 *
5400 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005401 * or null if no boolean array value was found.
5402 *
5403 * @see #putExtra(String, boolean[])
5404 */
5405 public boolean[] getBooleanArrayExtra(String name) {
5406 return mExtras == null ? null : mExtras.getBooleanArray(name);
5407 }
5408
5409 /**
5410 * Retrieve extended data from the intent.
5411 *
5412 * @param name The name of the desired item.
5413 *
5414 * @return the value of an item that previously added with putExtra()
5415 * or null if no byte array value was found.
5416 *
5417 * @see #putExtra(String, byte[])
5418 */
5419 public byte[] getByteArrayExtra(String name) {
5420 return mExtras == null ? null : mExtras.getByteArray(name);
5421 }
5422
5423 /**
5424 * Retrieve extended data from the intent.
5425 *
5426 * @param name The name of the desired item.
5427 *
5428 * @return the value of an item that previously added with putExtra()
5429 * or null if no short array value was found.
5430 *
5431 * @see #putExtra(String, short[])
5432 */
5433 public short[] getShortArrayExtra(String name) {
5434 return mExtras == null ? null : mExtras.getShortArray(name);
5435 }
5436
5437 /**
5438 * Retrieve extended data from the intent.
5439 *
5440 * @param name The name of the desired item.
5441 *
5442 * @return the value of an item that previously added with putExtra()
5443 * or null if no char array value was found.
5444 *
5445 * @see #putExtra(String, char[])
5446 */
5447 public char[] getCharArrayExtra(String name) {
5448 return mExtras == null ? null : mExtras.getCharArray(name);
5449 }
5450
5451 /**
5452 * Retrieve extended data from the intent.
5453 *
5454 * @param name The name of the desired item.
5455 *
5456 * @return the value of an item that previously added with putExtra()
5457 * or null if no int array value was found.
5458 *
5459 * @see #putExtra(String, int[])
5460 */
5461 public int[] getIntArrayExtra(String name) {
5462 return mExtras == null ? null : mExtras.getIntArray(name);
5463 }
5464
5465 /**
5466 * Retrieve extended data from the intent.
5467 *
5468 * @param name The name of the desired item.
5469 *
5470 * @return the value of an item that previously added with putExtra()
5471 * or null if no long array value was found.
5472 *
5473 * @see #putExtra(String, long[])
5474 */
5475 public long[] getLongArrayExtra(String name) {
5476 return mExtras == null ? null : mExtras.getLongArray(name);
5477 }
5478
5479 /**
5480 * Retrieve extended data from the intent.
5481 *
5482 * @param name The name of the desired item.
5483 *
5484 * @return the value of an item that previously added with putExtra()
5485 * or null if no float array value was found.
5486 *
5487 * @see #putExtra(String, float[])
5488 */
5489 public float[] getFloatArrayExtra(String name) {
5490 return mExtras == null ? null : mExtras.getFloatArray(name);
5491 }
5492
5493 /**
5494 * Retrieve extended data from the intent.
5495 *
5496 * @param name The name of the desired item.
5497 *
5498 * @return the value of an item that previously added with putExtra()
5499 * or null if no double array value was found.
5500 *
5501 * @see #putExtra(String, double[])
5502 */
5503 public double[] getDoubleArrayExtra(String name) {
5504 return mExtras == null ? null : mExtras.getDoubleArray(name);
5505 }
5506
5507 /**
5508 * Retrieve extended data from the intent.
5509 *
5510 * @param name The name of the desired item.
5511 *
5512 * @return the value of an item that previously added with putExtra()
5513 * or null if no String array value was found.
5514 *
5515 * @see #putExtra(String, String[])
5516 */
5517 public String[] getStringArrayExtra(String name) {
5518 return mExtras == null ? null : mExtras.getStringArray(name);
5519 }
5520
5521 /**
5522 * Retrieve extended data from the intent.
5523 *
5524 * @param name The name of the desired item.
5525 *
5526 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005527 * or null if no CharSequence array value was found.
5528 *
5529 * @see #putExtra(String, CharSequence[])
5530 */
5531 public CharSequence[] getCharSequenceArrayExtra(String name) {
5532 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5533 }
5534
5535 /**
5536 * Retrieve extended data from the intent.
5537 *
5538 * @param name The name of the desired item.
5539 *
5540 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005541 * or null if no Bundle value was found.
5542 *
5543 * @see #putExtra(String, Bundle)
5544 */
5545 public Bundle getBundleExtra(String name) {
5546 return mExtras == null ? null : mExtras.getBundle(name);
5547 }
5548
5549 /**
5550 * Retrieve extended data from the intent.
5551 *
5552 * @param name The name of the desired item.
5553 *
5554 * @return the value of an item that previously added with putExtra()
5555 * or null if no IBinder value was found.
5556 *
5557 * @see #putExtra(String, IBinder)
5558 *
5559 * @deprecated
5560 * @hide
5561 */
5562 @Deprecated
5563 public IBinder getIBinderExtra(String name) {
5564 return mExtras == null ? null : mExtras.getIBinder(name);
5565 }
5566
5567 /**
5568 * Retrieve extended data from the intent.
5569 *
5570 * @param name The name of the desired item.
5571 * @param defaultValue The default value to return in case no item is
5572 * associated with the key 'name'
5573 *
5574 * @return the value of an item that previously added with putExtra()
5575 * or defaultValue if none was found.
5576 *
5577 * @see #putExtra
5578 *
5579 * @deprecated
5580 * @hide
5581 */
5582 @Deprecated
5583 public Object getExtra(String name, Object defaultValue) {
5584 Object result = defaultValue;
5585 if (mExtras != null) {
5586 Object result2 = mExtras.get(name);
5587 if (result2 != null) {
5588 result = result2;
5589 }
5590 }
5591
5592 return result;
5593 }
5594
5595 /**
5596 * Retrieves a map of extended data from the intent.
5597 *
5598 * @return the map of all extras previously added with putExtra(),
5599 * or null if none have been added.
5600 */
5601 public Bundle getExtras() {
5602 return (mExtras != null)
5603 ? new Bundle(mExtras)
5604 : null;
5605 }
5606
5607 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07005608 * Filter extras to only basic types.
5609 * @hide
5610 */
5611 public void removeUnsafeExtras() {
5612 if (mExtras != null) {
5613 mExtras.filterValues();
5614 }
5615 }
5616
5617 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005618 * Retrieve any special flags associated with this intent. You will
5619 * normally just set them with {@link #setFlags} and let the system
5620 * take the appropriate action with them.
5621 *
5622 * @return int The currently set flags.
5623 *
5624 * @see #setFlags
5625 */
5626 public int getFlags() {
5627 return mFlags;
5628 }
5629
Dianne Hackborne7f97212011-02-24 14:40:20 -08005630 /** @hide */
5631 public boolean isExcludingStopped() {
5632 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5633 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5634 }
5635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005636 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005637 * Retrieve the application package name this Intent is limited to. When
5638 * resolving an Intent, if non-null this limits the resolution to only
5639 * components in the given application package.
5640 *
5641 * @return The name of the application package for the Intent.
5642 *
5643 * @see #resolveActivity
5644 * @see #setPackage
5645 */
5646 public String getPackage() {
5647 return mPackage;
5648 }
5649
5650 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005651 * Retrieve the concrete component associated with the intent. When receiving
5652 * an intent, this is the component that was found to best handle it (that is,
5653 * yourself) and will always be non-null; in all other cases it will be
5654 * null unless explicitly set.
5655 *
5656 * @return The name of the application component to handle the intent.
5657 *
5658 * @see #resolveActivity
5659 * @see #setComponent
5660 */
5661 public ComponentName getComponent() {
5662 return mComponent;
5663 }
5664
5665 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005666 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5667 * used as a hint to the receiver for animations and the like. Null means that there
5668 * is no source bounds.
5669 */
5670 public Rect getSourceBounds() {
5671 return mSourceBounds;
5672 }
5673
5674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005675 * Return the Activity component that should be used to handle this intent.
5676 * The appropriate component is determined based on the information in the
5677 * intent, evaluated as follows:
5678 *
5679 * <p>If {@link #getComponent} returns an explicit class, that is returned
5680 * without any further consideration.
5681 *
5682 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5683 * category to be considered.
5684 *
5685 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5686 * action.
5687 *
5688 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5689 * this type.
5690 *
5691 * <p>If {@link #addCategory} has added any categories, the activity must
5692 * handle ALL of the categories specified.
5693 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005694 * <p>If {@link #getPackage} is non-NULL, only activity components in
5695 * that application package will be considered.
5696 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005697 * <p>If there are no activities that satisfy all of these conditions, a
5698 * null string is returned.
5699 *
5700 * <p>If multiple activities are found to satisfy the intent, the one with
5701 * the highest priority will be used. If there are multiple activities
5702 * with the same priority, the system will either pick the best activity
5703 * based on user preference, or resolve to a system class that will allow
5704 * the user to pick an activity and forward from there.
5705 *
5706 * <p>This method is implemented simply by calling
5707 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5708 * true.</p>
5709 * <p> This API is called for you as part of starting an activity from an
5710 * intent. You do not normally need to call it yourself.</p>
5711 *
5712 * @param pm The package manager with which to resolve the Intent.
5713 *
5714 * @return Name of the component implementing an activity that can
5715 * display the intent.
5716 *
5717 * @see #setComponent
5718 * @see #getComponent
5719 * @see #resolveActivityInfo
5720 */
5721 public ComponentName resolveActivity(PackageManager pm) {
5722 if (mComponent != null) {
5723 return mComponent;
5724 }
5725
5726 ResolveInfo info = pm.resolveActivity(
5727 this, PackageManager.MATCH_DEFAULT_ONLY);
5728 if (info != null) {
5729 return new ComponentName(
5730 info.activityInfo.applicationInfo.packageName,
5731 info.activityInfo.name);
5732 }
5733
5734 return null;
5735 }
5736
5737 /**
5738 * Resolve the Intent into an {@link ActivityInfo}
5739 * describing the activity that should execute the intent. Resolution
5740 * follows the same rules as described for {@link #resolveActivity}, but
5741 * you get back the completely information about the resolved activity
5742 * instead of just its class name.
5743 *
5744 * @param pm The package manager with which to resolve the Intent.
5745 * @param flags Addition information to retrieve as per
5746 * {@link PackageManager#getActivityInfo(ComponentName, int)
5747 * PackageManager.getActivityInfo()}.
5748 *
5749 * @return PackageManager.ActivityInfo
5750 *
5751 * @see #resolveActivity
5752 */
5753 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5754 ActivityInfo ai = null;
5755 if (mComponent != null) {
5756 try {
5757 ai = pm.getActivityInfo(mComponent, flags);
5758 } catch (PackageManager.NameNotFoundException e) {
5759 // ignore
5760 }
5761 } else {
5762 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005763 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005764 if (info != null) {
5765 ai = info.activityInfo;
5766 }
5767 }
5768
5769 return ai;
5770 }
5771
5772 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005773 * Special function for use by the system to resolve service
5774 * intents to system apps. Throws an exception if there are
5775 * multiple potential matches to the Intent. Returns null if
5776 * there are no matches.
5777 * @hide
5778 */
5779 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5780 if (mComponent != null) {
5781 return mComponent;
5782 }
5783
5784 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5785 if (results == null) {
5786 return null;
5787 }
5788 ComponentName comp = null;
5789 for (int i=0; i<results.size(); i++) {
5790 ResolveInfo ri = results.get(i);
5791 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5792 continue;
5793 }
5794 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5795 ri.serviceInfo.name);
5796 if (comp != null) {
5797 throw new IllegalStateException("Multiple system services handle " + this
5798 + ": " + comp + ", " + foundComp);
5799 }
5800 comp = foundComp;
5801 }
5802 return comp;
5803 }
5804
5805 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005806 * Set the general action to be performed.
5807 *
5808 * @param action An action name, such as ACTION_VIEW. Application-specific
5809 * actions should be prefixed with the vendor's package name.
5810 *
5811 * @return Returns the same Intent object, for chaining multiple calls
5812 * into a single statement.
5813 *
5814 * @see #getAction
5815 */
5816 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005817 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005818 return this;
5819 }
5820
5821 /**
5822 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005823 * clears any type that was previously set by {@link #setType} or
5824 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005825 *
Nick Pellyccae4122012-01-09 14:12:58 -08005826 * <p><em>Note: scheme matching in the Android framework is
5827 * case-sensitive, unlike the formal RFC. As a result,
5828 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005829 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005830 * {@link #setDataAndNormalize}
5831 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005832 *
Nick Pellyccae4122012-01-09 14:12:58 -08005833 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005834 *
5835 * @return Returns the same Intent object, for chaining multiple calls
5836 * into a single statement.
5837 *
5838 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005839 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005840 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005841 */
5842 public Intent setData(Uri data) {
5843 mData = data;
5844 mType = null;
5845 return this;
5846 }
5847
5848 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005849 * Normalize and set the data this intent is operating on.
5850 *
5851 * <p>This method automatically clears any type that was
5852 * previously set (for example, by {@link #setType}).
5853 *
5854 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005855 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005856 * so really this is just a convenience method for
5857 * <pre>
5858 * setData(data.normalize())
5859 * </pre>
5860 *
5861 * @param data The Uri of the data this intent is now targeting.
5862 *
5863 * @return Returns the same Intent object, for chaining multiple calls
5864 * into a single statement.
5865 *
5866 * @see #getData
5867 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005868 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005869 */
5870 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005871 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005872 }
5873
5874 /**
5875 * Set an explicit MIME data type.
5876 *
5877 * <p>This is used to create intents that only specify a type and not data,
5878 * for example to indicate the type of data to return.
5879 *
5880 * <p>This method automatically clears any data that was
5881 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005882 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005883 * <p><em>Note: MIME type matching in the Android framework is
5884 * case-sensitive, unlike formal RFC MIME types. As a result,
5885 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005886 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5887 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005888 *
5889 * @param type The MIME type of the data being handled by this intent.
5890 *
5891 * @return Returns the same Intent object, for chaining multiple calls
5892 * into a single statement.
5893 *
5894 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005895 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005896 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005897 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005898 */
5899 public Intent setType(String type) {
5900 mData = null;
5901 mType = type;
5902 return this;
5903 }
5904
5905 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005906 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005907 *
Nick Pellyccae4122012-01-09 14:12:58 -08005908 * <p>This is used to create intents that only specify a type and not data,
5909 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005910 *
Nick Pellyccae4122012-01-09 14:12:58 -08005911 * <p>This method automatically clears any data that was
5912 * previously set (for example by {@link #setData}).
5913 *
5914 * <p>The MIME type is normalized using
5915 * {@link #normalizeMimeType} before it is set,
5916 * so really this is just a convenience method for
5917 * <pre>
5918 * setType(Intent.normalizeMimeType(type))
5919 * </pre>
5920 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005921 * @param type The MIME type of the data being handled by this intent.
5922 *
5923 * @return Returns the same Intent object, for chaining multiple calls
5924 * into a single statement.
5925 *
Nick Pellyccae4122012-01-09 14:12:58 -08005926 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005927 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005928 * @see #normalizeMimeType
5929 */
5930 public Intent setTypeAndNormalize(String type) {
5931 return setType(normalizeMimeType(type));
5932 }
5933
5934 /**
5935 * (Usually optional) Set the data for the intent along with an explicit
5936 * MIME data type. This method should very rarely be used -- it allows you
5937 * to override the MIME type that would ordinarily be inferred from the
5938 * data with your own type given here.
5939 *
5940 * <p><em>Note: MIME type and Uri scheme matching in the
5941 * Android framework is case-sensitive, unlike the formal RFC definitions.
5942 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005943 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005944 * {@link #setDataAndTypeAndNormalize}
5945 * to ensure that they are converted to lower case.</em>
5946 *
5947 * @param data The Uri of the data this intent is now targeting.
5948 * @param type The MIME type of the data being handled by this intent.
5949 *
5950 * @return Returns the same Intent object, for chaining multiple calls
5951 * into a single statement.
5952 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005953 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005954 * @see #setData
5955 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005956 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005957 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005958 */
5959 public Intent setDataAndType(Uri data, String type) {
5960 mData = data;
5961 mType = type;
5962 return this;
5963 }
5964
5965 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005966 * (Usually optional) Normalize and set both the data Uri and an explicit
5967 * MIME data type. This method should very rarely be used -- it allows you
5968 * to override the MIME type that would ordinarily be inferred from the
5969 * data with your own type given here.
5970 *
5971 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005972 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005973 * before they are set, so really this is just a convenience method for
5974 * <pre>
5975 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5976 * </pre>
5977 *
5978 * @param data The Uri of the data this intent is now targeting.
5979 * @param type The MIME type of the data being handled by this intent.
5980 *
5981 * @return Returns the same Intent object, for chaining multiple calls
5982 * into a single statement.
5983 *
5984 * @see #setType
5985 * @see #setData
5986 * @see #setDataAndType
5987 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005988 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005989 */
5990 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005991 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005992 }
5993
5994 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005995 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005996 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005997 * activities that provide <em>all</em> of the requested categories will be
5998 * used.
5999 *
6000 * @param category The desired category. This can be either one of the
6001 * predefined Intent categories, or a custom category in your own
6002 * namespace.
6003 *
6004 * @return Returns the same Intent object, for chaining multiple calls
6005 * into a single statement.
6006 *
6007 * @see #hasCategory
6008 * @see #removeCategory
6009 */
6010 public Intent addCategory(String category) {
6011 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006012 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006013 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006014 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006015 return this;
6016 }
6017
6018 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006019 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006020 *
6021 * @param category The category to remove.
6022 *
6023 * @see #addCategory
6024 */
6025 public void removeCategory(String category) {
6026 if (mCategories != null) {
6027 mCategories.remove(category);
6028 if (mCategories.size() == 0) {
6029 mCategories = null;
6030 }
6031 }
6032 }
6033
6034 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006035 * Set a selector for this Intent. This is a modification to the kinds of
6036 * things the Intent will match. If the selector is set, it will be used
6037 * when trying to find entities that can handle the Intent, instead of the
6038 * main contents of the Intent. This allows you build an Intent containing
6039 * a generic protocol while targeting it more specifically.
6040 *
6041 * <p>An example of where this may be used is with things like
6042 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6043 * Intent that will launch the Browser application. However, the correct
6044 * main entry point of an application is actually {@link #ACTION_MAIN}
6045 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6046 * used to specify the actual Activity to launch. If you launch the browser
6047 * with something different, undesired behavior may happen if the user has
6048 * previously or later launches it the normal way, since they do not match.
6049 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6050 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6051 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6052 *
6053 * <p>Setting a selector does not impact the behavior of
6054 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6055 * desired behavior of a selector -- it does not impact the base meaning
6056 * of the Intent, just what kinds of things will be matched against it
6057 * when determining who can handle it.</p>
6058 *
6059 * <p>You can not use both a selector and {@link #setPackage(String)} on
6060 * the same base Intent.</p>
6061 *
6062 * @param selector The desired selector Intent; set to null to not use
6063 * a special selector.
6064 */
6065 public void setSelector(Intent selector) {
6066 if (selector == this) {
6067 throw new IllegalArgumentException(
6068 "Intent being set as a selector of itself");
6069 }
6070 if (selector != null && mPackage != null) {
6071 throw new IllegalArgumentException(
6072 "Can't set selector when package name is already set");
6073 }
6074 mSelector = selector;
6075 }
6076
6077 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006078 * Set a {@link ClipData} associated with this Intent. This replaces any
6079 * previously set ClipData.
6080 *
6081 * <p>The ClipData in an intent is not used for Intent matching or other
6082 * such operations. Semantically it is like extras, used to transmit
6083 * additional data with the Intent. The main feature of using this over
6084 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
6085 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
6086 * items included in the clip data. This is useful, in particular, if
6087 * you want to transmit an Intent containing multiple <code>content:</code>
6088 * URIs for which the recipient may not have global permission to access the
6089 * content provider.
6090 *
6091 * <p>If the ClipData contains items that are themselves Intents, any
6092 * grant flags in those Intents will be ignored. Only the top-level flags
6093 * of the main Intent are respected, and will be applied to all Uri or
6094 * Intent items in the clip (or sub-items of the clip).
6095 *
6096 * <p>The MIME type, label, and icon in the ClipData object are not
6097 * directly used by Intent. Applications should generally rely on the
6098 * MIME type of the Intent itself, not what it may find in the ClipData.
6099 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05006100 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006101 *
6102 * @param clip The new clip to set. May be null to clear the current clip.
6103 */
6104 public void setClipData(ClipData clip) {
6105 mClipData = clip;
6106 }
6107
6108 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006109 * This is NOT a secure mechanism to identify the user who sent the intent.
6110 * When the intent is sent to a different user, it is used to fix uris by adding the userId
6111 * who sent the intent.
6112 * @hide
6113 */
6114 public void setContentUserHint(int contentUserHint) {
6115 mContentUserHint = contentUserHint;
6116 }
6117
6118 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006119 * Add extended data to the intent. The name must include a package
6120 * prefix, for example the app com.android.contacts would use names
6121 * like "com.android.contacts.ShowAll".
6122 *
6123 * @param name The name of the extra data, with package prefix.
6124 * @param value The boolean data value.
6125 *
6126 * @return Returns the same Intent object, for chaining multiple calls
6127 * into a single statement.
6128 *
6129 * @see #putExtras
6130 * @see #removeExtra
6131 * @see #getBooleanExtra(String, boolean)
6132 */
6133 public Intent putExtra(String name, boolean value) {
6134 if (mExtras == null) {
6135 mExtras = new Bundle();
6136 }
6137 mExtras.putBoolean(name, value);
6138 return this;
6139 }
6140
6141 /**
6142 * Add extended data to the intent. The name must include a package
6143 * prefix, for example the app com.android.contacts would use names
6144 * like "com.android.contacts.ShowAll".
6145 *
6146 * @param name The name of the extra data, with package prefix.
6147 * @param value The byte data value.
6148 *
6149 * @return Returns the same Intent object, for chaining multiple calls
6150 * into a single statement.
6151 *
6152 * @see #putExtras
6153 * @see #removeExtra
6154 * @see #getByteExtra(String, byte)
6155 */
6156 public Intent putExtra(String name, byte value) {
6157 if (mExtras == null) {
6158 mExtras = new Bundle();
6159 }
6160 mExtras.putByte(name, value);
6161 return this;
6162 }
6163
6164 /**
6165 * Add extended data to the intent. The name must include a package
6166 * prefix, for example the app com.android.contacts would use names
6167 * like "com.android.contacts.ShowAll".
6168 *
6169 * @param name The name of the extra data, with package prefix.
6170 * @param value The char data value.
6171 *
6172 * @return Returns the same Intent object, for chaining multiple calls
6173 * into a single statement.
6174 *
6175 * @see #putExtras
6176 * @see #removeExtra
6177 * @see #getCharExtra(String, char)
6178 */
6179 public Intent putExtra(String name, char value) {
6180 if (mExtras == null) {
6181 mExtras = new Bundle();
6182 }
6183 mExtras.putChar(name, value);
6184 return this;
6185 }
6186
6187 /**
6188 * Add extended data to the intent. The name must include a package
6189 * prefix, for example the app com.android.contacts would use names
6190 * like "com.android.contacts.ShowAll".
6191 *
6192 * @param name The name of the extra data, with package prefix.
6193 * @param value The short data value.
6194 *
6195 * @return Returns the same Intent object, for chaining multiple calls
6196 * into a single statement.
6197 *
6198 * @see #putExtras
6199 * @see #removeExtra
6200 * @see #getShortExtra(String, short)
6201 */
6202 public Intent putExtra(String name, short value) {
6203 if (mExtras == null) {
6204 mExtras = new Bundle();
6205 }
6206 mExtras.putShort(name, value);
6207 return this;
6208 }
6209
6210 /**
6211 * Add extended data to the intent. The name must include a package
6212 * prefix, for example the app com.android.contacts would use names
6213 * like "com.android.contacts.ShowAll".
6214 *
6215 * @param name The name of the extra data, with package prefix.
6216 * @param value The integer data value.
6217 *
6218 * @return Returns the same Intent object, for chaining multiple calls
6219 * into a single statement.
6220 *
6221 * @see #putExtras
6222 * @see #removeExtra
6223 * @see #getIntExtra(String, int)
6224 */
6225 public Intent putExtra(String name, int value) {
6226 if (mExtras == null) {
6227 mExtras = new Bundle();
6228 }
6229 mExtras.putInt(name, value);
6230 return this;
6231 }
6232
6233 /**
6234 * Add extended data to the intent. The name must include a package
6235 * prefix, for example the app com.android.contacts would use names
6236 * like "com.android.contacts.ShowAll".
6237 *
6238 * @param name The name of the extra data, with package prefix.
6239 * @param value The long data value.
6240 *
6241 * @return Returns the same Intent object, for chaining multiple calls
6242 * into a single statement.
6243 *
6244 * @see #putExtras
6245 * @see #removeExtra
6246 * @see #getLongExtra(String, long)
6247 */
6248 public Intent putExtra(String name, long value) {
6249 if (mExtras == null) {
6250 mExtras = new Bundle();
6251 }
6252 mExtras.putLong(name, value);
6253 return this;
6254 }
6255
6256 /**
6257 * Add extended data to the intent. The name must include a package
6258 * prefix, for example the app com.android.contacts would use names
6259 * like "com.android.contacts.ShowAll".
6260 *
6261 * @param name The name of the extra data, with package prefix.
6262 * @param value The float data value.
6263 *
6264 * @return Returns the same Intent object, for chaining multiple calls
6265 * into a single statement.
6266 *
6267 * @see #putExtras
6268 * @see #removeExtra
6269 * @see #getFloatExtra(String, float)
6270 */
6271 public Intent putExtra(String name, float value) {
6272 if (mExtras == null) {
6273 mExtras = new Bundle();
6274 }
6275 mExtras.putFloat(name, value);
6276 return this;
6277 }
6278
6279 /**
6280 * Add extended data to the intent. The name must include a package
6281 * prefix, for example the app com.android.contacts would use names
6282 * like "com.android.contacts.ShowAll".
6283 *
6284 * @param name The name of the extra data, with package prefix.
6285 * @param value The double data value.
6286 *
6287 * @return Returns the same Intent object, for chaining multiple calls
6288 * into a single statement.
6289 *
6290 * @see #putExtras
6291 * @see #removeExtra
6292 * @see #getDoubleExtra(String, double)
6293 */
6294 public Intent putExtra(String name, double value) {
6295 if (mExtras == null) {
6296 mExtras = new Bundle();
6297 }
6298 mExtras.putDouble(name, value);
6299 return this;
6300 }
6301
6302 /**
6303 * Add extended data to the intent. The name must include a package
6304 * prefix, for example the app com.android.contacts would use names
6305 * like "com.android.contacts.ShowAll".
6306 *
6307 * @param name The name of the extra data, with package prefix.
6308 * @param value The String data value.
6309 *
6310 * @return Returns the same Intent object, for chaining multiple calls
6311 * into a single statement.
6312 *
6313 * @see #putExtras
6314 * @see #removeExtra
6315 * @see #getStringExtra(String)
6316 */
6317 public Intent putExtra(String name, String value) {
6318 if (mExtras == null) {
6319 mExtras = new Bundle();
6320 }
6321 mExtras.putString(name, value);
6322 return this;
6323 }
6324
6325 /**
6326 * Add extended data to the intent. The name must include a package
6327 * prefix, for example the app com.android.contacts would use names
6328 * like "com.android.contacts.ShowAll".
6329 *
6330 * @param name The name of the extra data, with package prefix.
6331 * @param value The CharSequence data value.
6332 *
6333 * @return Returns the same Intent object, for chaining multiple calls
6334 * into a single statement.
6335 *
6336 * @see #putExtras
6337 * @see #removeExtra
6338 * @see #getCharSequenceExtra(String)
6339 */
6340 public Intent putExtra(String name, CharSequence value) {
6341 if (mExtras == null) {
6342 mExtras = new Bundle();
6343 }
6344 mExtras.putCharSequence(name, value);
6345 return this;
6346 }
6347
6348 /**
6349 * Add extended data to the intent. The name must include a package
6350 * prefix, for example the app com.android.contacts would use names
6351 * like "com.android.contacts.ShowAll".
6352 *
6353 * @param name The name of the extra data, with package prefix.
6354 * @param value The Parcelable data value.
6355 *
6356 * @return Returns the same Intent object, for chaining multiple calls
6357 * into a single statement.
6358 *
6359 * @see #putExtras
6360 * @see #removeExtra
6361 * @see #getParcelableExtra(String)
6362 */
6363 public Intent putExtra(String name, Parcelable value) {
6364 if (mExtras == null) {
6365 mExtras = new Bundle();
6366 }
6367 mExtras.putParcelable(name, value);
6368 return this;
6369 }
6370
6371 /**
6372 * Add extended data to the intent. The name must include a package
6373 * prefix, for example the app com.android.contacts would use names
6374 * like "com.android.contacts.ShowAll".
6375 *
6376 * @param name The name of the extra data, with package prefix.
6377 * @param value The Parcelable[] data value.
6378 *
6379 * @return Returns the same Intent object, for chaining multiple calls
6380 * into a single statement.
6381 *
6382 * @see #putExtras
6383 * @see #removeExtra
6384 * @see #getParcelableArrayExtra(String)
6385 */
6386 public Intent putExtra(String name, Parcelable[] value) {
6387 if (mExtras == null) {
6388 mExtras = new Bundle();
6389 }
6390 mExtras.putParcelableArray(name, value);
6391 return this;
6392 }
6393
6394 /**
6395 * Add extended data to the intent. The name must include a package
6396 * prefix, for example the app com.android.contacts would use names
6397 * like "com.android.contacts.ShowAll".
6398 *
6399 * @param name The name of the extra data, with package prefix.
6400 * @param value The ArrayList<Parcelable> data value.
6401 *
6402 * @return Returns the same Intent object, for chaining multiple calls
6403 * into a single statement.
6404 *
6405 * @see #putExtras
6406 * @see #removeExtra
6407 * @see #getParcelableArrayListExtra(String)
6408 */
6409 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6410 if (mExtras == null) {
6411 mExtras = new Bundle();
6412 }
6413 mExtras.putParcelableArrayList(name, value);
6414 return this;
6415 }
6416
6417 /**
6418 * Add extended data to the intent. The name must include a package
6419 * prefix, for example the app com.android.contacts would use names
6420 * like "com.android.contacts.ShowAll".
6421 *
6422 * @param name The name of the extra data, with package prefix.
6423 * @param value The ArrayList<Integer> data value.
6424 *
6425 * @return Returns the same Intent object, for chaining multiple calls
6426 * into a single statement.
6427 *
6428 * @see #putExtras
6429 * @see #removeExtra
6430 * @see #getIntegerArrayListExtra(String)
6431 */
6432 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6433 if (mExtras == null) {
6434 mExtras = new Bundle();
6435 }
6436 mExtras.putIntegerArrayList(name, value);
6437 return this;
6438 }
6439
6440 /**
6441 * Add extended data to the intent. The name must include a package
6442 * prefix, for example the app com.android.contacts would use names
6443 * like "com.android.contacts.ShowAll".
6444 *
6445 * @param name The name of the extra data, with package prefix.
6446 * @param value The ArrayList<String> data value.
6447 *
6448 * @return Returns the same Intent object, for chaining multiple calls
6449 * into a single statement.
6450 *
6451 * @see #putExtras
6452 * @see #removeExtra
6453 * @see #getStringArrayListExtra(String)
6454 */
6455 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6456 if (mExtras == null) {
6457 mExtras = new Bundle();
6458 }
6459 mExtras.putStringArrayList(name, value);
6460 return this;
6461 }
6462
6463 /**
6464 * Add extended data to the intent. The name must include a package
6465 * prefix, for example the app com.android.contacts would use names
6466 * like "com.android.contacts.ShowAll".
6467 *
6468 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006469 * @param value The ArrayList<CharSequence> data value.
6470 *
6471 * @return Returns the same Intent object, for chaining multiple calls
6472 * into a single statement.
6473 *
6474 * @see #putExtras
6475 * @see #removeExtra
6476 * @see #getCharSequenceArrayListExtra(String)
6477 */
6478 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6479 if (mExtras == null) {
6480 mExtras = new Bundle();
6481 }
6482 mExtras.putCharSequenceArrayList(name, value);
6483 return this;
6484 }
6485
6486 /**
6487 * Add extended data to the intent. The name must include a package
6488 * prefix, for example the app com.android.contacts would use names
6489 * like "com.android.contacts.ShowAll".
6490 *
6491 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006492 * @param value The Serializable data value.
6493 *
6494 * @return Returns the same Intent object, for chaining multiple calls
6495 * into a single statement.
6496 *
6497 * @see #putExtras
6498 * @see #removeExtra
6499 * @see #getSerializableExtra(String)
6500 */
6501 public Intent putExtra(String name, Serializable value) {
6502 if (mExtras == null) {
6503 mExtras = new Bundle();
6504 }
6505 mExtras.putSerializable(name, value);
6506 return this;
6507 }
6508
6509 /**
6510 * Add extended data to the intent. The name must include a package
6511 * prefix, for example the app com.android.contacts would use names
6512 * like "com.android.contacts.ShowAll".
6513 *
6514 * @param name The name of the extra data, with package prefix.
6515 * @param value The boolean array data value.
6516 *
6517 * @return Returns the same Intent object, for chaining multiple calls
6518 * into a single statement.
6519 *
6520 * @see #putExtras
6521 * @see #removeExtra
6522 * @see #getBooleanArrayExtra(String)
6523 */
6524 public Intent putExtra(String name, boolean[] value) {
6525 if (mExtras == null) {
6526 mExtras = new Bundle();
6527 }
6528 mExtras.putBooleanArray(name, value);
6529 return this;
6530 }
6531
6532 /**
6533 * Add extended data to the intent. The name must include a package
6534 * prefix, for example the app com.android.contacts would use names
6535 * like "com.android.contacts.ShowAll".
6536 *
6537 * @param name The name of the extra data, with package prefix.
6538 * @param value The byte array data value.
6539 *
6540 * @return Returns the same Intent object, for chaining multiple calls
6541 * into a single statement.
6542 *
6543 * @see #putExtras
6544 * @see #removeExtra
6545 * @see #getByteArrayExtra(String)
6546 */
6547 public Intent putExtra(String name, byte[] value) {
6548 if (mExtras == null) {
6549 mExtras = new Bundle();
6550 }
6551 mExtras.putByteArray(name, value);
6552 return this;
6553 }
6554
6555 /**
6556 * Add extended data to the intent. The name must include a package
6557 * prefix, for example the app com.android.contacts would use names
6558 * like "com.android.contacts.ShowAll".
6559 *
6560 * @param name The name of the extra data, with package prefix.
6561 * @param value The short array data value.
6562 *
6563 * @return Returns the same Intent object, for chaining multiple calls
6564 * into a single statement.
6565 *
6566 * @see #putExtras
6567 * @see #removeExtra
6568 * @see #getShortArrayExtra(String)
6569 */
6570 public Intent putExtra(String name, short[] value) {
6571 if (mExtras == null) {
6572 mExtras = new Bundle();
6573 }
6574 mExtras.putShortArray(name, value);
6575 return this;
6576 }
6577
6578 /**
6579 * Add extended data to the intent. The name must include a package
6580 * prefix, for example the app com.android.contacts would use names
6581 * like "com.android.contacts.ShowAll".
6582 *
6583 * @param name The name of the extra data, with package prefix.
6584 * @param value The char array data value.
6585 *
6586 * @return Returns the same Intent object, for chaining multiple calls
6587 * into a single statement.
6588 *
6589 * @see #putExtras
6590 * @see #removeExtra
6591 * @see #getCharArrayExtra(String)
6592 */
6593 public Intent putExtra(String name, char[] value) {
6594 if (mExtras == null) {
6595 mExtras = new Bundle();
6596 }
6597 mExtras.putCharArray(name, value);
6598 return this;
6599 }
6600
6601 /**
6602 * Add extended data to the intent. The name must include a package
6603 * prefix, for example the app com.android.contacts would use names
6604 * like "com.android.contacts.ShowAll".
6605 *
6606 * @param name The name of the extra data, with package prefix.
6607 * @param value The int array data value.
6608 *
6609 * @return Returns the same Intent object, for chaining multiple calls
6610 * into a single statement.
6611 *
6612 * @see #putExtras
6613 * @see #removeExtra
6614 * @see #getIntArrayExtra(String)
6615 */
6616 public Intent putExtra(String name, int[] value) {
6617 if (mExtras == null) {
6618 mExtras = new Bundle();
6619 }
6620 mExtras.putIntArray(name, value);
6621 return this;
6622 }
6623
6624 /**
6625 * Add extended data to the intent. The name must include a package
6626 * prefix, for example the app com.android.contacts would use names
6627 * like "com.android.contacts.ShowAll".
6628 *
6629 * @param name The name of the extra data, with package prefix.
6630 * @param value The byte array data value.
6631 *
6632 * @return Returns the same Intent object, for chaining multiple calls
6633 * into a single statement.
6634 *
6635 * @see #putExtras
6636 * @see #removeExtra
6637 * @see #getLongArrayExtra(String)
6638 */
6639 public Intent putExtra(String name, long[] value) {
6640 if (mExtras == null) {
6641 mExtras = new Bundle();
6642 }
6643 mExtras.putLongArray(name, value);
6644 return this;
6645 }
6646
6647 /**
6648 * Add extended data to the intent. The name must include a package
6649 * prefix, for example the app com.android.contacts would use names
6650 * like "com.android.contacts.ShowAll".
6651 *
6652 * @param name The name of the extra data, with package prefix.
6653 * @param value The float array data value.
6654 *
6655 * @return Returns the same Intent object, for chaining multiple calls
6656 * into a single statement.
6657 *
6658 * @see #putExtras
6659 * @see #removeExtra
6660 * @see #getFloatArrayExtra(String)
6661 */
6662 public Intent putExtra(String name, float[] value) {
6663 if (mExtras == null) {
6664 mExtras = new Bundle();
6665 }
6666 mExtras.putFloatArray(name, value);
6667 return this;
6668 }
6669
6670 /**
6671 * Add extended data to the intent. The name must include a package
6672 * prefix, for example the app com.android.contacts would use names
6673 * like "com.android.contacts.ShowAll".
6674 *
6675 * @param name The name of the extra data, with package prefix.
6676 * @param value The double array data value.
6677 *
6678 * @return Returns the same Intent object, for chaining multiple calls
6679 * into a single statement.
6680 *
6681 * @see #putExtras
6682 * @see #removeExtra
6683 * @see #getDoubleArrayExtra(String)
6684 */
6685 public Intent putExtra(String name, double[] value) {
6686 if (mExtras == null) {
6687 mExtras = new Bundle();
6688 }
6689 mExtras.putDoubleArray(name, value);
6690 return this;
6691 }
6692
6693 /**
6694 * Add extended data to the intent. The name must include a package
6695 * prefix, for example the app com.android.contacts would use names
6696 * like "com.android.contacts.ShowAll".
6697 *
6698 * @param name The name of the extra data, with package prefix.
6699 * @param value The String array data value.
6700 *
6701 * @return Returns the same Intent object, for chaining multiple calls
6702 * into a single statement.
6703 *
6704 * @see #putExtras
6705 * @see #removeExtra
6706 * @see #getStringArrayExtra(String)
6707 */
6708 public Intent putExtra(String name, String[] value) {
6709 if (mExtras == null) {
6710 mExtras = new Bundle();
6711 }
6712 mExtras.putStringArray(name, value);
6713 return this;
6714 }
6715
6716 /**
6717 * Add extended data to the intent. The name must include a package
6718 * prefix, for example the app com.android.contacts would use names
6719 * like "com.android.contacts.ShowAll".
6720 *
6721 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006722 * @param value The CharSequence array data value.
6723 *
6724 * @return Returns the same Intent object, for chaining multiple calls
6725 * into a single statement.
6726 *
6727 * @see #putExtras
6728 * @see #removeExtra
6729 * @see #getCharSequenceArrayExtra(String)
6730 */
6731 public Intent putExtra(String name, CharSequence[] value) {
6732 if (mExtras == null) {
6733 mExtras = new Bundle();
6734 }
6735 mExtras.putCharSequenceArray(name, value);
6736 return this;
6737 }
6738
6739 /**
6740 * Add extended data to the intent. The name must include a package
6741 * prefix, for example the app com.android.contacts would use names
6742 * like "com.android.contacts.ShowAll".
6743 *
6744 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006745 * @param value The Bundle data value.
6746 *
6747 * @return Returns the same Intent object, for chaining multiple calls
6748 * into a single statement.
6749 *
6750 * @see #putExtras
6751 * @see #removeExtra
6752 * @see #getBundleExtra(String)
6753 */
6754 public Intent putExtra(String name, Bundle value) {
6755 if (mExtras == null) {
6756 mExtras = new Bundle();
6757 }
6758 mExtras.putBundle(name, value);
6759 return this;
6760 }
6761
6762 /**
6763 * Add extended data to the intent. The name must include a package
6764 * prefix, for example the app com.android.contacts would use names
6765 * like "com.android.contacts.ShowAll".
6766 *
6767 * @param name The name of the extra data, with package prefix.
6768 * @param value The IBinder data value.
6769 *
6770 * @return Returns the same Intent object, for chaining multiple calls
6771 * into a single statement.
6772 *
6773 * @see #putExtras
6774 * @see #removeExtra
6775 * @see #getIBinderExtra(String)
6776 *
6777 * @deprecated
6778 * @hide
6779 */
6780 @Deprecated
6781 public Intent putExtra(String name, IBinder value) {
6782 if (mExtras == null) {
6783 mExtras = new Bundle();
6784 }
6785 mExtras.putIBinder(name, value);
6786 return this;
6787 }
6788
6789 /**
6790 * Copy all extras in 'src' in to this intent.
6791 *
6792 * @param src Contains the extras to copy.
6793 *
6794 * @see #putExtra
6795 */
6796 public Intent putExtras(Intent src) {
6797 if (src.mExtras != null) {
6798 if (mExtras == null) {
6799 mExtras = new Bundle(src.mExtras);
6800 } else {
6801 mExtras.putAll(src.mExtras);
6802 }
6803 }
6804 return this;
6805 }
6806
6807 /**
6808 * Add a set of extended data to the intent. The keys must include a package
6809 * prefix, for example the app com.android.contacts would use names
6810 * like "com.android.contacts.ShowAll".
6811 *
6812 * @param extras The Bundle of extras to add to this intent.
6813 *
6814 * @see #putExtra
6815 * @see #removeExtra
6816 */
6817 public Intent putExtras(Bundle extras) {
6818 if (mExtras == null) {
6819 mExtras = new Bundle();
6820 }
6821 mExtras.putAll(extras);
6822 return this;
6823 }
6824
6825 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006826 * Completely replace the extras in the Intent with the extras in the
6827 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006828 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006829 * @param src The exact extras contained in this Intent are copied
6830 * into the target intent, replacing any that were previously there.
6831 */
6832 public Intent replaceExtras(Intent src) {
6833 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6834 return this;
6835 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006836
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006837 /**
6838 * Completely replace the extras in the Intent with the given Bundle of
6839 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006840 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006841 * @param extras The new set of extras in the Intent, or null to erase
6842 * all extras.
6843 */
6844 public Intent replaceExtras(Bundle extras) {
6845 mExtras = extras != null ? new Bundle(extras) : null;
6846 return this;
6847 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006848
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006849 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006850 * Remove extended data from the intent.
6851 *
6852 * @see #putExtra
6853 */
6854 public void removeExtra(String name) {
6855 if (mExtras != null) {
6856 mExtras.remove(name);
6857 if (mExtras.size() == 0) {
6858 mExtras = null;
6859 }
6860 }
6861 }
6862
6863 /**
6864 * Set special flags controlling how this intent is handled. Most values
6865 * here depend on the type of component being executed by the Intent,
6866 * specifically the FLAG_ACTIVITY_* flags are all for use with
6867 * {@link Context#startActivity Context.startActivity()} and the
6868 * FLAG_RECEIVER_* flags are all for use with
6869 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6870 *
Scott Main7aee61f2011-02-08 11:25:01 -08006871 * <p>See the
6872 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6873 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874 * the behavior of your application.
6875 *
6876 * @param flags The desired flags.
6877 *
6878 * @return Returns the same Intent object, for chaining multiple calls
6879 * into a single statement.
6880 *
6881 * @see #getFlags
6882 * @see #addFlags
6883 *
6884 * @see #FLAG_GRANT_READ_URI_PERMISSION
6885 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006886 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6887 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006888 * @see #FLAG_DEBUG_LOG_RESOLUTION
6889 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006890 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006891 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006892 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006893 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006894 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6895 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006896 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006897 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006898 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006899 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006900 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006901 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006902 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006903 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6904 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006905 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006906 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006907 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006908 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6909 */
6910 public Intent setFlags(int flags) {
6911 mFlags = flags;
6912 return this;
6913 }
6914
6915 /**
6916 * Add additional flags to the intent (or with existing flags
6917 * value).
6918 *
6919 * @param flags The new flags to set.
6920 *
6921 * @return Returns the same Intent object, for chaining multiple calls
6922 * into a single statement.
6923 *
6924 * @see #setFlags
6925 */
6926 public Intent addFlags(int flags) {
6927 mFlags |= flags;
6928 return this;
6929 }
6930
6931 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006932 * (Usually optional) Set an explicit application package name that limits
6933 * the components this Intent will resolve to. If left to the default
6934 * value of null, all components in all applications will considered.
6935 * If non-null, the Intent can only match the components in the given
6936 * application package.
6937 *
6938 * @param packageName The name of the application package to handle the
6939 * intent, or null to allow any application package.
6940 *
6941 * @return Returns the same Intent object, for chaining multiple calls
6942 * into a single statement.
6943 *
6944 * @see #getPackage
6945 * @see #resolveActivity
6946 */
6947 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006948 if (packageName != null && mSelector != null) {
6949 throw new IllegalArgumentException(
6950 "Can't set package name when selector is already set");
6951 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006952 mPackage = packageName;
6953 return this;
6954 }
6955
6956 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006957 * (Usually optional) Explicitly set the component to handle the intent.
6958 * If left with the default value of null, the system will determine the
6959 * appropriate class to use based on the other fields (action, data,
6960 * type, categories) in the Intent. If this class is defined, the
6961 * specified class will always be used regardless of the other fields. You
6962 * should only set this value when you know you absolutely want a specific
6963 * class to be used; otherwise it is better to let the system find the
6964 * appropriate class so that you will respect the installed applications
6965 * and user preferences.
6966 *
6967 * @param component The name of the application component to handle the
6968 * intent, or null to let the system find one for you.
6969 *
6970 * @return Returns the same Intent object, for chaining multiple calls
6971 * into a single statement.
6972 *
6973 * @see #setClass
6974 * @see #setClassName(Context, String)
6975 * @see #setClassName(String, String)
6976 * @see #getComponent
6977 * @see #resolveActivity
6978 */
6979 public Intent setComponent(ComponentName component) {
6980 mComponent = component;
6981 return this;
6982 }
6983
6984 /**
6985 * Convenience for calling {@link #setComponent} with an
6986 * explicit class name.
6987 *
6988 * @param packageContext A Context of the application package implementing
6989 * this class.
6990 * @param className The name of a class inside of the application package
6991 * that will be used as the component for this Intent.
6992 *
6993 * @return Returns the same Intent object, for chaining multiple calls
6994 * into a single statement.
6995 *
6996 * @see #setComponent
6997 * @see #setClass
6998 */
6999 public Intent setClassName(Context packageContext, String className) {
7000 mComponent = new ComponentName(packageContext, className);
7001 return this;
7002 }
7003
7004 /**
7005 * Convenience for calling {@link #setComponent} with an
7006 * explicit application package name and class name.
7007 *
7008 * @param packageName The name of the package implementing the desired
7009 * component.
7010 * @param className The name of a class inside of the application package
7011 * that will be used as the component for this Intent.
7012 *
7013 * @return Returns the same Intent object, for chaining multiple calls
7014 * into a single statement.
7015 *
7016 * @see #setComponent
7017 * @see #setClass
7018 */
7019 public Intent setClassName(String packageName, String className) {
7020 mComponent = new ComponentName(packageName, className);
7021 return this;
7022 }
7023
7024 /**
7025 * Convenience for calling {@link #setComponent(ComponentName)} with the
7026 * name returned by a {@link Class} object.
7027 *
7028 * @param packageContext A Context of the application package implementing
7029 * this class.
7030 * @param cls The class name to set, equivalent to
7031 * <code>setClassName(context, cls.getName())</code>.
7032 *
7033 * @return Returns the same Intent object, for chaining multiple calls
7034 * into a single statement.
7035 *
7036 * @see #setComponent
7037 */
7038 public Intent setClass(Context packageContext, Class<?> cls) {
7039 mComponent = new ComponentName(packageContext, cls);
7040 return this;
7041 }
7042
7043 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007044 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7045 * used as a hint to the receiver for animations and the like. Null means that there
7046 * is no source bounds.
7047 */
7048 public void setSourceBounds(Rect r) {
7049 if (r != null) {
7050 mSourceBounds = new Rect(r);
7051 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007052 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007053 }
7054 }
7055
Tor Norbyed9273d62013-05-30 15:59:53 -07007056 /** @hide */
7057 @IntDef(flag = true,
7058 value = {
7059 FILL_IN_ACTION,
7060 FILL_IN_DATA,
7061 FILL_IN_CATEGORIES,
7062 FILL_IN_COMPONENT,
7063 FILL_IN_PACKAGE,
7064 FILL_IN_SOURCE_BOUNDS,
7065 FILL_IN_SELECTOR,
7066 FILL_IN_CLIP_DATA
7067 })
7068 @Retention(RetentionPolicy.SOURCE)
7069 public @interface FillInFlags {}
7070
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007071 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007072 * Use with {@link #fillIn} to allow the current action value to be
7073 * overwritten, even if it is already set.
7074 */
7075 public static final int FILL_IN_ACTION = 1<<0;
7076
7077 /**
7078 * Use with {@link #fillIn} to allow the current data or type value
7079 * overwritten, even if it is already set.
7080 */
7081 public static final int FILL_IN_DATA = 1<<1;
7082
7083 /**
7084 * Use with {@link #fillIn} to allow the current categories to be
7085 * overwritten, even if they are already set.
7086 */
7087 public static final int FILL_IN_CATEGORIES = 1<<2;
7088
7089 /**
7090 * Use with {@link #fillIn} to allow the current component value to be
7091 * overwritten, even if it is already set.
7092 */
7093 public static final int FILL_IN_COMPONENT = 1<<3;
7094
7095 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007096 * Use with {@link #fillIn} to allow the current package value to be
7097 * overwritten, even if it is already set.
7098 */
7099 public static final int FILL_IN_PACKAGE = 1<<4;
7100
7101 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007102 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007103 * overwritten, even if it is already set.
7104 */
7105 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
7106
7107 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007108 * Use with {@link #fillIn} to allow the current selector to be
7109 * overwritten, even if it is already set.
7110 */
7111 public static final int FILL_IN_SELECTOR = 1<<6;
7112
7113 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007114 * Use with {@link #fillIn} to allow the current ClipData to be
7115 * overwritten, even if it is already set.
7116 */
7117 public static final int FILL_IN_CLIP_DATA = 1<<7;
7118
7119 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007120 * Copy the contents of <var>other</var> in to this object, but only
7121 * where fields are not defined by this object. For purposes of a field
7122 * being defined, the following pieces of data in the Intent are
7123 * considered to be separate fields:
7124 *
7125 * <ul>
7126 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08007127 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007128 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
7129 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007130 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007131 * <li> component, as set by {@link #setComponent(ComponentName)} or
7132 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007133 * <li> source bounds, as set by {@link #setSourceBounds}.
7134 * <li> selector, as set by {@link #setSelector(Intent)}.
7135 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007136 * <li> each top-level name in the associated extras.
7137 * </ul>
7138 *
7139 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007140 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007141 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7142 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
7143 * the restriction where the corresponding field will not be replaced if
7144 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007145 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007146 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
7147 * is explicitly specified. The selector will only be copied if
7148 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07007149 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007150 * <p>For example, consider Intent A with {data="foo", categories="bar"}
7151 * and Intent B with {action="gotit", data-type="some/thing",
7152 * categories="one","two"}.
7153 *
7154 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
7155 * containing: {action="gotit", data-type="some/thing",
7156 * categories="bar"}.
7157 *
7158 * @param other Another Intent whose values are to be used to fill in
7159 * the current one.
7160 * @param flags Options to control which fields can be filled in.
7161 *
7162 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007163 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07007164 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7165 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
7166 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007167 */
Tor Norbyed9273d62013-05-30 15:59:53 -07007168 @FillInFlags
7169 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007170 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007171 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007172 if (other.mAction != null
7173 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007174 mAction = other.mAction;
7175 changes |= FILL_IN_ACTION;
7176 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007177 if ((other.mData != null || other.mType != null)
7178 && ((mData == null && mType == null)
7179 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007180 mData = other.mData;
7181 mType = other.mType;
7182 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007183 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007184 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007185 if (other.mCategories != null
7186 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007187 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007188 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007189 }
7190 changes |= FILL_IN_CATEGORIES;
7191 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007192 if (other.mPackage != null
7193 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007194 // Only do this if mSelector is not set.
7195 if (mSelector == null) {
7196 mPackage = other.mPackage;
7197 changes |= FILL_IN_PACKAGE;
7198 }
7199 }
7200 // Selector is special: it can only be set if explicitly allowed,
7201 // for the same reason as the component name.
7202 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
7203 if (mPackage == null) {
7204 mSelector = new Intent(other.mSelector);
7205 mPackage = null;
7206 changes |= FILL_IN_SELECTOR;
7207 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007208 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007209 if (other.mClipData != null
7210 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
7211 mClipData = other.mClipData;
7212 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007213 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007214 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007215 // Component is special: it can -only- be set if explicitly allowed,
7216 // since otherwise the sender could force the intent somewhere the
7217 // originator didn't intend.
7218 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007219 mComponent = other.mComponent;
7220 changes |= FILL_IN_COMPONENT;
7221 }
7222 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007223 if (other.mSourceBounds != null
7224 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
7225 mSourceBounds = new Rect(other.mSourceBounds);
7226 changes |= FILL_IN_SOURCE_BOUNDS;
7227 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007228 if (mExtras == null) {
7229 if (other.mExtras != null) {
7230 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007231 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007232 }
7233 } else if (other.mExtras != null) {
7234 try {
7235 Bundle newb = new Bundle(other.mExtras);
7236 newb.putAll(mExtras);
7237 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007238 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007239 } catch (RuntimeException e) {
7240 // Modifying the extras can cause us to unparcel the contents
7241 // of the bundle, and if we do this in the system process that
7242 // may fail. We really should handle this (i.e., the Bundle
7243 // impl shouldn't be on top of a plain map), but for now just
7244 // ignore it and keep the original contents. :(
7245 Log.w("Intent", "Failure filling in extras", e);
7246 }
7247 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007248 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
7249 && other.mContentUserHint != UserHandle.USER_CURRENT) {
7250 mContentUserHint = other.mContentUserHint;
7251 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007252 return changes;
7253 }
7254
7255 /**
7256 * Wrapper class holding an Intent and implementing comparisons on it for
7257 * the purpose of filtering. The class implements its
7258 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
7259 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
7260 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
7261 * on the wrapped Intent.
7262 */
7263 public static final class FilterComparison {
7264 private final Intent mIntent;
7265 private final int mHashCode;
7266
7267 public FilterComparison(Intent intent) {
7268 mIntent = intent;
7269 mHashCode = intent.filterHashCode();
7270 }
7271
7272 /**
7273 * Return the Intent that this FilterComparison represents.
7274 * @return Returns the Intent held by the FilterComparison. Do
7275 * not modify!
7276 */
7277 public Intent getIntent() {
7278 return mIntent;
7279 }
7280
7281 @Override
7282 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007283 if (obj instanceof FilterComparison) {
7284 Intent other = ((FilterComparison)obj).mIntent;
7285 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007286 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007287 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007288 }
7289
7290 @Override
7291 public int hashCode() {
7292 return mHashCode;
7293 }
7294 }
7295
7296 /**
7297 * Determine if two intents are the same for the purposes of intent
7298 * resolution (filtering). That is, if their action, data, type,
7299 * class, and categories are the same. This does <em>not</em> compare
7300 * any extra data included in the intents.
7301 *
7302 * @param other The other Intent to compare against.
7303 *
7304 * @return Returns true if action, data, type, class, and categories
7305 * are the same.
7306 */
7307 public boolean filterEquals(Intent other) {
7308 if (other == null) {
7309 return false;
7310 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07007311 if (!Objects.equals(this.mAction, other.mAction)) return false;
7312 if (!Objects.equals(this.mData, other.mData)) return false;
7313 if (!Objects.equals(this.mType, other.mType)) return false;
7314 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
7315 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
7316 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007317
7318 return true;
7319 }
7320
7321 /**
7322 * Generate hash code that matches semantics of filterEquals().
7323 *
7324 * @return Returns the hash value of the action, data, type, class, and
7325 * categories.
7326 *
7327 * @see #filterEquals
7328 */
7329 public int filterHashCode() {
7330 int code = 0;
7331 if (mAction != null) {
7332 code += mAction.hashCode();
7333 }
7334 if (mData != null) {
7335 code += mData.hashCode();
7336 }
7337 if (mType != null) {
7338 code += mType.hashCode();
7339 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007340 if (mPackage != null) {
7341 code += mPackage.hashCode();
7342 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007343 if (mComponent != null) {
7344 code += mComponent.hashCode();
7345 }
7346 if (mCategories != null) {
7347 code += mCategories.hashCode();
7348 }
7349 return code;
7350 }
7351
7352 @Override
7353 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007354 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007355
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007356 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007357 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007358 b.append(" }");
7359
7360 return b.toString();
7361 }
7362
7363 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007364 public String toInsecureString() {
7365 StringBuilder b = new StringBuilder(128);
7366
7367 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007368 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007369 b.append(" }");
7370
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007371 return b.toString();
7372 }
Romain Guy4969af72009-06-17 10:53:19 -07007373
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007374 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007375 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007376 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007377
7378 b.append("Intent { ");
7379 toShortString(b, false, true, true, true);
7380 b.append(" }");
7381
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007382 return b.toString();
7383 }
7384
7385 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007386 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
7387 StringBuilder b = new StringBuilder(128);
7388 toShortString(b, secure, comp, extras, clip);
7389 return b.toString();
7390 }
7391
7392 /** @hide */
7393 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
7394 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007395 boolean first = true;
7396 if (mAction != null) {
7397 b.append("act=").append(mAction);
7398 first = false;
7399 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007400 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007401 if (!first) {
7402 b.append(' ');
7403 }
7404 first = false;
7405 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007406 for (int i=0; i<mCategories.size(); i++) {
7407 if (i > 0) b.append(',');
7408 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007409 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007410 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007411 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007412 if (mData != null) {
7413 if (!first) {
7414 b.append(' ');
7415 }
7416 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007417 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007418 if (secure) {
7419 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007420 } else {
7421 b.append(mData);
7422 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007423 }
7424 if (mType != null) {
7425 if (!first) {
7426 b.append(' ');
7427 }
7428 first = false;
7429 b.append("typ=").append(mType);
7430 }
7431 if (mFlags != 0) {
7432 if (!first) {
7433 b.append(' ');
7434 }
7435 first = false;
7436 b.append("flg=0x").append(Integer.toHexString(mFlags));
7437 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007438 if (mPackage != null) {
7439 if (!first) {
7440 b.append(' ');
7441 }
7442 first = false;
7443 b.append("pkg=").append(mPackage);
7444 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007445 if (comp && mComponent != null) {
7446 if (!first) {
7447 b.append(' ');
7448 }
7449 first = false;
7450 b.append("cmp=").append(mComponent.flattenToShortString());
7451 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007452 if (mSourceBounds != null) {
7453 if (!first) {
7454 b.append(' ');
7455 }
7456 first = false;
7457 b.append("bnds=").append(mSourceBounds.toShortString());
7458 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007459 if (mClipData != null) {
7460 if (!first) {
7461 b.append(' ');
7462 }
7463 first = false;
7464 if (clip) {
7465 b.append("clip={");
7466 mClipData.toShortString(b);
7467 b.append('}');
7468 } else {
7469 b.append("(has clip)");
7470 }
7471 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007472 if (extras && mExtras != null) {
7473 if (!first) {
7474 b.append(' ');
7475 }
7476 first = false;
7477 b.append("(has extras)");
7478 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007479 if (mContentUserHint != UserHandle.USER_CURRENT) {
7480 if (!first) {
7481 b.append(' ');
7482 }
7483 first = false;
7484 b.append("u=").append(mContentUserHint);
7485 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007486 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007487 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007488 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007489 b.append("}");
7490 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007491 }
7492
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007493 /**
7494 * Call {@link #toUri} with 0 flags.
7495 * @deprecated Use {@link #toUri} instead.
7496 */
7497 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007498 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007499 return toUri(0);
7500 }
7501
7502 /**
7503 * Convert this Intent into a String holding a URI representation of it.
7504 * The returned URI string has been properly URI encoded, so it can be
7505 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7506 * Intent's data as the base URI, with an additional fragment describing
7507 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007508 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007509 * <p>You can convert the returned string back to an Intent with
7510 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007511 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007512 * @param flags Additional operating flags. Either 0,
7513 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007514 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007515 * @return Returns a URI encoding URI string describing the entire contents
7516 * of the Intent.
7517 */
7518 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007519 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007520 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
7521 if (mPackage == null) {
7522 throw new IllegalArgumentException(
7523 "Intent must include an explicit package name to build an android-app: "
7524 + this);
7525 }
7526 uri.append("android-app://");
7527 uri.append(mPackage);
7528 String scheme = null;
7529 if (mData != null) {
7530 scheme = mData.getScheme();
7531 if (scheme != null) {
7532 uri.append('/');
7533 uri.append(scheme);
7534 String authority = mData.getEncodedAuthority();
7535 if (authority != null) {
7536 uri.append('/');
7537 uri.append(authority);
7538 String path = mData.getEncodedPath();
7539 if (path != null) {
7540 uri.append(path);
7541 }
7542 String queryParams = mData.getEncodedQuery();
7543 if (queryParams != null) {
7544 uri.append('?');
7545 uri.append(queryParams);
7546 }
7547 String fragment = mData.getEncodedFragment();
7548 if (fragment != null) {
7549 uri.append('#');
7550 uri.append(fragment);
7551 }
7552 }
7553 }
7554 }
7555 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
7556 mPackage, flags);
7557 return uri.toString();
7558 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007559 String scheme = null;
7560 if (mData != null) {
7561 String data = mData.toString();
7562 if ((flags&URI_INTENT_SCHEME) != 0) {
7563 final int N = data.length();
7564 for (int i=0; i<N; i++) {
7565 char c = data.charAt(i);
7566 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7567 || c == '.' || c == '-') {
7568 continue;
7569 }
7570 if (c == ':' && i > 0) {
7571 // Valid scheme.
7572 scheme = data.substring(0, i);
7573 uri.append("intent:");
7574 data = data.substring(i+1);
7575 break;
7576 }
Tom Taylord4a47292009-12-21 13:59:18 -08007577
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007578 // No scheme.
7579 break;
7580 }
7581 }
7582 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007583
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007584 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7585 uri.append("intent:");
7586 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007587
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007588 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007589
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007590 return uri.toString();
7591 }
7592
7593 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
7594 String defPackage, int flags) {
7595 StringBuilder frag = new StringBuilder(128);
7596
7597 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007598 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08007599 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007600 // Note that for now we are not going to try to handle the
7601 // data part; not clear how to represent this as a URI, and
7602 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007603 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
7604 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007605 }
7606
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007607 if (frag.length() > 0) {
7608 uri.append("#Intent;");
7609 uri.append(frag);
7610 uri.append("end");
7611 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007612 }
7613
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007614 private void toUriInner(StringBuilder uri, String scheme, String defAction,
7615 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007616 if (scheme != null) {
7617 uri.append("scheme=").append(scheme).append(';');
7618 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007619 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007620 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007621 }
7622 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007623 for (int i=0; i<mCategories.size(); i++) {
7624 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007625 }
7626 }
7627 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007628 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007629 }
7630 if (mFlags != 0) {
7631 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7632 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007633 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007634 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7635 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007636 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007637 uri.append("component=").append(Uri.encode(
7638 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007639 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007640 if (mSourceBounds != null) {
7641 uri.append("sourceBounds=")
7642 .append(Uri.encode(mSourceBounds.flattenToString()))
7643 .append(';');
7644 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007645 if (mExtras != null) {
7646 for (String key : mExtras.keySet()) {
7647 final Object value = mExtras.get(key);
7648 char entryType =
7649 value instanceof String ? 'S' :
7650 value instanceof Boolean ? 'B' :
7651 value instanceof Byte ? 'b' :
7652 value instanceof Character ? 'c' :
7653 value instanceof Double ? 'd' :
7654 value instanceof Float ? 'f' :
7655 value instanceof Integer ? 'i' :
7656 value instanceof Long ? 'l' :
7657 value instanceof Short ? 's' :
7658 '\0';
7659
7660 if (entryType != '\0') {
7661 uri.append(entryType);
7662 uri.append('.');
7663 uri.append(Uri.encode(key));
7664 uri.append('=');
7665 uri.append(Uri.encode(value.toString()));
7666 uri.append(';');
7667 }
7668 }
7669 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007670 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007671
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007672 public int describeContents() {
7673 return (mExtras != null) ? mExtras.describeContents() : 0;
7674 }
7675
7676 public void writeToParcel(Parcel out, int flags) {
7677 out.writeString(mAction);
7678 Uri.writeToParcel(out, mData);
7679 out.writeString(mType);
7680 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007681 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007682 ComponentName.writeToParcel(mComponent, out);
7683
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007684 if (mSourceBounds != null) {
7685 out.writeInt(1);
7686 mSourceBounds.writeToParcel(out, flags);
7687 } else {
7688 out.writeInt(0);
7689 }
7690
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007691 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007692 final int N = mCategories.size();
7693 out.writeInt(N);
7694 for (int i=0; i<N; i++) {
7695 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007696 }
7697 } else {
7698 out.writeInt(0);
7699 }
7700
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007701 if (mSelector != null) {
7702 out.writeInt(1);
7703 mSelector.writeToParcel(out, flags);
7704 } else {
7705 out.writeInt(0);
7706 }
7707
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007708 if (mClipData != null) {
7709 out.writeInt(1);
7710 mClipData.writeToParcel(out, flags);
7711 } else {
7712 out.writeInt(0);
7713 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007714 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007715 out.writeBundle(mExtras);
7716 }
7717
7718 public static final Parcelable.Creator<Intent> CREATOR
7719 = new Parcelable.Creator<Intent>() {
7720 public Intent createFromParcel(Parcel in) {
7721 return new Intent(in);
7722 }
7723 public Intent[] newArray(int size) {
7724 return new Intent[size];
7725 }
7726 };
7727
Dianne Hackborneb034652009-09-07 00:49:58 -07007728 /** @hide */
7729 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007730 readFromParcel(in);
7731 }
7732
7733 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007734 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007735 mData = Uri.CREATOR.createFromParcel(in);
7736 mType = in.readString();
7737 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007738 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007739 mComponent = ComponentName.readFromParcel(in);
7740
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007741 if (in.readInt() != 0) {
7742 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7743 }
7744
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007745 int N = in.readInt();
7746 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007747 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007748 int i;
7749 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007750 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007751 }
7752 } else {
7753 mCategories = null;
7754 }
7755
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007756 if (in.readInt() != 0) {
7757 mSelector = new Intent(in);
7758 }
7759
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007760 if (in.readInt() != 0) {
7761 mClipData = new ClipData(in);
7762 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007763 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007764 mExtras = in.readBundle();
7765 }
7766
7767 /**
7768 * Parses the "intent" element (and its children) from XML and instantiates
7769 * an Intent object. The given XML parser should be located at the tag
7770 * where parsing should start (often named "intent"), from which the
7771 * basic action, data, type, and package and class name will be
7772 * retrieved. The function will then parse in to any child elements,
7773 * looking for <category android:name="xxx"> tags to add categories and
7774 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7775 * to the intent.
7776 *
7777 * @param resources The Resources to use when inflating resources.
7778 * @param parser The XML parser pointing at an "intent" tag.
7779 * @param attrs The AttributeSet interface for retrieving extended
7780 * attribute data at the current <var>parser</var> location.
7781 * @return An Intent object matching the XML data.
7782 * @throws XmlPullParserException If there was an XML parsing error.
7783 * @throws IOException If there was an I/O error.
7784 */
7785 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7786 throws XmlPullParserException, IOException {
7787 Intent intent = new Intent();
7788
7789 TypedArray sa = resources.obtainAttributes(attrs,
7790 com.android.internal.R.styleable.Intent);
7791
7792 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7793
7794 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7795 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7796 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7797
7798 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7799 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7800 if (packageName != null && className != null) {
7801 intent.setComponent(new ComponentName(packageName, className));
7802 }
7803
7804 sa.recycle();
7805
7806 int outerDepth = parser.getDepth();
7807 int type;
7808 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7809 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7810 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7811 continue;
7812 }
7813
7814 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007815 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007816 sa = resources.obtainAttributes(attrs,
7817 com.android.internal.R.styleable.IntentCategory);
7818 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7819 sa.recycle();
7820
7821 if (cat != null) {
7822 intent.addCategory(cat);
7823 }
7824 XmlUtils.skipCurrentTag(parser);
7825
Craig Mautner21d24a22014-04-23 11:45:37 -07007826 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007827 if (intent.mExtras == null) {
7828 intent.mExtras = new Bundle();
7829 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007830 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007831 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007832
7833 } else {
7834 XmlUtils.skipCurrentTag(parser);
7835 }
7836 }
7837
7838 return intent;
7839 }
Nick Pellyccae4122012-01-09 14:12:58 -08007840
Craig Mautner21d24a22014-04-23 11:45:37 -07007841 /** @hide */
7842 public void saveToXml(XmlSerializer out) throws IOException {
7843 if (mAction != null) {
7844 out.attribute(null, ATTR_ACTION, mAction);
7845 }
7846 if (mData != null) {
7847 out.attribute(null, ATTR_DATA, mData.toString());
7848 }
7849 if (mType != null) {
7850 out.attribute(null, ATTR_TYPE, mType);
7851 }
7852 if (mComponent != null) {
7853 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7854 }
7855 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7856
7857 if (mCategories != null) {
7858 out.startTag(null, TAG_CATEGORIES);
7859 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7860 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7861 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007862 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007863 }
7864 }
7865
7866 /** @hide */
7867 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7868 XmlPullParserException {
7869 Intent intent = new Intent();
7870 final int outerDepth = in.getDepth();
7871
7872 int attrCount = in.getAttributeCount();
7873 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7874 final String attrName = in.getAttributeName(attrNdx);
7875 final String attrValue = in.getAttributeValue(attrNdx);
7876 if (ATTR_ACTION.equals(attrName)) {
7877 intent.setAction(attrValue);
7878 } else if (ATTR_DATA.equals(attrName)) {
7879 intent.setData(Uri.parse(attrValue));
7880 } else if (ATTR_TYPE.equals(attrName)) {
7881 intent.setType(attrValue);
7882 } else if (ATTR_COMPONENT.equals(attrName)) {
7883 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7884 } else if (ATTR_FLAGS.equals(attrName)) {
7885 intent.setFlags(Integer.valueOf(attrValue, 16));
7886 } else {
7887 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7888 }
7889 }
7890
7891 int event;
7892 String name;
7893 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7894 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7895 if (event == XmlPullParser.START_TAG) {
7896 name = in.getName();
7897 if (TAG_CATEGORIES.equals(name)) {
7898 attrCount = in.getAttributeCount();
7899 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7900 intent.addCategory(in.getAttributeValue(attrNdx));
7901 }
7902 } else {
7903 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7904 XmlUtils.skipCurrentTag(in);
7905 }
7906 }
7907 }
7908
7909 return intent;
7910 }
7911
Nick Pellyccae4122012-01-09 14:12:58 -08007912 /**
7913 * Normalize a MIME data type.
7914 *
7915 * <p>A normalized MIME type has white-space trimmed,
7916 * content-type parameters removed, and is lower-case.
7917 * This aligns the type with Android best practices for
7918 * intent filtering.
7919 *
7920 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7921 * "text/x-vCard" becomes "text/x-vcard".
7922 *
7923 * <p>All MIME types received from outside Android (such as user input,
7924 * or external sources like Bluetooth, NFC, or the Internet) should
7925 * be normalized before they are used to create an Intent.
7926 *
7927 * @param type MIME data type to normalize
7928 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007929 * @see #setType
7930 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007931 */
7932 public static String normalizeMimeType(String type) {
7933 if (type == null) {
7934 return null;
7935 }
7936
Elliott Hughescb64d432013-08-02 10:00:44 -07007937 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007938
7939 final int semicolonIndex = type.indexOf(';');
7940 if (semicolonIndex != -1) {
7941 type = type.substring(0, semicolonIndex);
7942 }
7943 return type;
7944 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007945
7946 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007947 * Prepare this {@link Intent} to leave an app process.
7948 *
7949 * @hide
7950 */
7951 public void prepareToLeaveProcess() {
7952 setAllowFds(false);
7953
7954 if (mSelector != null) {
7955 mSelector.prepareToLeaveProcess();
7956 }
7957 if (mClipData != null) {
7958 mClipData.prepareToLeaveProcess();
7959 }
7960
7961 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7962 // There are several ACTION_MEDIA_* broadcasts that send file://
7963 // Uris, so only check common actions.
7964 if (ACTION_VIEW.equals(mAction) ||
7965 ACTION_EDIT.equals(mAction) ||
7966 ACTION_ATTACH_DATA.equals(mAction)) {
7967 mData.checkFileUriExposed("Intent.getData()");
7968 }
7969 }
7970 }
7971
7972 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007973 * @hide
7974 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007975 public void prepareToEnterProcess() {
7976 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00007977 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
7978 fixUris(mContentUserHint);
7979 mContentUserHint = UserHandle.USER_CURRENT;
7980 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007981 }
7982 }
7983
7984 /**
7985 * @hide
7986 */
7987 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007988 Uri data = getData();
7989 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007990 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007991 }
7992 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007993 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007994 }
7995 String action = getAction();
7996 if (ACTION_SEND.equals(action)) {
7997 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7998 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007999 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008000 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008001 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008002 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8003 if (streams != null) {
8004 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8005 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008006 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008007 }
8008 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8009 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008010 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8011 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8012 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8013 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8014 if (output != null) {
8015 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8016 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008017 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008018 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008019
8020 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008021 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008022 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8023 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008024 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008025 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008026 * @hide
8027 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008028 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008029 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008030 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008031
8032 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008033 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008034
8035 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008036 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008037 // Inspect contained intents to see if we need to migrate extras. We
8038 // don't promote ClipData to the parent, since ChooserActivity will
8039 // already start the picked item as the caller, and we can't combine
8040 // the flags in a safe way.
8041
8042 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008043 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008044 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8045 if (intent != null) {
8046 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008047 }
8048 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008049 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008050 try {
8051 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8052 if (intents != null) {
8053 for (int i = 0; i < intents.length; i++) {
8054 final Intent intent = (Intent) intents[i];
8055 if (intent != null) {
8056 migrated |= intent.migrateExtraStreamToClipData();
8057 }
8058 }
8059 }
8060 } catch (ClassCastException e) {
8061 }
8062 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008063
8064 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008065 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008066 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8067 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
8068 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
8069 if (stream != null || text != null || htmlText != null) {
8070 final ClipData clipData = new ClipData(
8071 null, new String[] { getType() },
8072 new ClipData.Item(text, htmlText, null, stream));
8073 setClipData(clipData);
8074 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008075 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008076 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008077 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008078 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008079
8080 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008081 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008082 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8083 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
8084 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
8085 int num = -1;
8086 if (streams != null) {
8087 num = streams.size();
8088 }
8089 if (texts != null) {
8090 if (num >= 0 && num != texts.size()) {
8091 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008092 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008093 }
8094 num = texts.size();
8095 }
8096 if (htmlTexts != null) {
8097 if (num >= 0 && num != htmlTexts.size()) {
8098 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008099 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008100 }
8101 num = htmlTexts.size();
8102 }
8103 if (num > 0) {
8104 final ClipData clipData = new ClipData(
8105 null, new String[] { getType() },
8106 makeClipItem(streams, texts, htmlTexts, 0));
8107
8108 for (int i = 1; i < num; i++) {
8109 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
8110 }
8111
8112 setClipData(clipData);
8113 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008114 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008115 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008116 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008117 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008118 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8119 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8120 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8121 final Uri output;
8122 try {
8123 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8124 } catch (ClassCastException e) {
8125 return false;
8126 }
8127 if (output != null) {
8128 setClipData(ClipData.newRawUri("", output));
8129 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
8130 return true;
8131 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008132 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008133
8134 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008135 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07008136
8137 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
8138 ArrayList<String> htmlTexts, int which) {
8139 Uri uri = streams != null ? streams.get(which) : null;
8140 CharSequence text = texts != null ? texts.get(which) : null;
8141 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
8142 return new ClipData.Item(text, htmlText, null, uri);
8143 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07008144
8145 /** @hide */
8146 public boolean isDocument() {
8147 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
8148 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008149}