blob: 0175d6289e6886926962a4bdcd30070b162c8bc8 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070020import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import org.xmlpull.v1.XmlPullParser;
22import org.xmlpull.v1.XmlPullParserException;
23
Tor Norbyed9273d62013-05-30 15:59:53 -070024import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070025import android.annotation.SdkConstant;
26import android.annotation.SdkConstant.SdkConstantType;
27import android.content.pm.ActivityInfo;
28import android.content.pm.PackageManager;
29import android.content.pm.ResolveInfo;
30import android.content.res.Resources;
31import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080032import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070033import android.net.Uri;
34import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070038import android.os.StrictMode;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070039import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070040import android.provider.DocumentsProvider;
41import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070042import android.util.AttributeSet;
43import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080044
45import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070046
47import java.io.IOException;
48import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070049import java.lang.annotation.Retention;
50import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070051import java.net.URISyntaxException;
52import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070053import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080054import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070055import java.util.Set;
56
57/**
58 * An intent is an abstract description of an operation to be performed. It
59 * can be used with {@link Context#startActivity(Intent) startActivity} to
60 * launch an {@link android.app.Activity},
61 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
62 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
63 * and {@link android.content.Context#startService} or
64 * {@link android.content.Context#bindService} to communicate with a
65 * background {@link android.app.Service}.
66 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070067 * <p>An Intent provides a facility for performing late runtime binding between the code in
68 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070069 * can be thought of as the glue between activities. It is basically a passive data structure
70 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070071 *
72 * <div class="special reference">
73 * <h3>Developer Guides</h3>
74 * <p>For information about how to create and resolve intents, read the
75 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
76 * developer guide.</p>
77 * </div>
78 *
79 * <a name="IntentStructure"></a>
80 * <h3>Intent Structure</h3>
81 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070082 *
83 * <ul>
84 * <li> <p><b>action</b> -- The general action to be performed, such as
85 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
86 * etc.</p>
87 * </li>
88 * <li> <p><b>data</b> -- The data to operate on, such as a person record
89 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
90 * </li>
91 * </ul>
92 *
93 *
94 * <p>Some examples of action/data pairs are:</p>
95 *
96 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070097 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070098 * information about the person whose identifier is "1".</p>
99 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700100 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700101 * the phone dialer with the person filled in.</p>
102 * </li>
103 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
104 * the phone dialer with the given number filled in. Note how the
105 * VIEW action does what what is considered the most reasonable thing for
106 * a particular URI.</p>
107 * </li>
108 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
109 * the phone dialer with the given number filled in.</p>
110 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700111 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700112 * information about the person whose identifier is "1".</p>
113 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700114 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700115 * a list of people, which the user can browse through. This example is a
116 * typical top-level entry into the Contacts application, showing you the
117 * list of people. Selecting a particular person to view would result in a
118 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
119 * being used to start an activity to display that person.</p>
120 * </li>
121 * </ul>
122 *
123 * <p>In addition to these primary attributes, there are a number of secondary
124 * attributes that you can also include with an intent:</p>
125 *
126 * <ul>
127 * <li> <p><b>category</b> -- Gives additional information about the action
128 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
129 * appear in the Launcher as a top-level application, while
130 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
131 * of alternative actions the user can perform on a piece of data.</p>
132 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
133 * intent data. Normally the type is inferred from the data itself.
134 * By setting this attribute, you disable that evaluation and force
135 * an explicit type.</p>
136 * <li> <p><b>component</b> -- Specifies an explicit name of a component
137 * class to use for the intent. Normally this is determined by looking
138 * at the other information in the intent (the action, data/type, and
139 * categories) and matching that with a component that can handle it.
140 * If this attribute is set then none of the evaluation is performed,
141 * and this component is used exactly as is. By specifying this attribute,
142 * all of the other Intent attributes become optional.</p>
143 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
144 * This can be used to provide extended information to the component.
145 * For example, if we have a action to send an e-mail message, we could
146 * also include extra pieces of data here to supply a subject, body,
147 * etc.</p>
148 * </ul>
149 *
150 * <p>Here are some examples of other operations you can specify as intents
151 * using these additional parameters:</p>
152 *
153 * <ul>
154 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
155 * Launch the home screen.</p>
156 * </li>
157 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
158 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
159 * vnd.android.cursor.item/phone}</i></b>
160 * -- Display the list of people's phone numbers, allowing the user to
161 * browse through them and pick one and return it to the parent activity.</p>
162 * </li>
163 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
164 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
165 * -- Display all pickers for data that can be opened with
166 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
167 * allowing the user to pick one of them and then some data inside of it
168 * and returning the resulting URI to the caller. This can be used,
169 * for example, in an e-mail application to allow the user to pick some
170 * data to include as an attachment.</p>
171 * </li>
172 * </ul>
173 *
174 * <p>There are a variety of standard Intent action and category constants
175 * defined in the Intent class, but applications can also define their own.
176 * These strings use java style scoping, to ensure they are unique -- for
177 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700178 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700179 *
180 * <p>Put together, the set of actions, data types, categories, and extra data
181 * defines a language for the system allowing for the expression of phrases
182 * such as "call john smith's cell". As applications are added to the system,
183 * they can extend this language by adding new actions, types, and categories, or
184 * they can modify the behavior of existing phrases by supplying their own
185 * activities that handle them.</p>
186 *
187 * <a name="IntentResolution"></a>
188 * <h3>Intent Resolution</h3>
189 *
190 * <p>There are two primary forms of intents you will use.
191 *
192 * <ul>
193 * <li> <p><b>Explicit Intents</b> have specified a component (via
194 * {@link #setComponent} or {@link #setClass}), which provides the exact
195 * class to be run. Often these will not include any other information,
196 * simply being a way for an application to launch various internal
197 * activities it has as the user interacts with the application.
198 *
199 * <li> <p><b>Implicit Intents</b> have not specified a component;
200 * instead, they must include enough information for the system to
201 * determine which of the available components is best to run for that
202 * intent.
203 * </ul>
204 *
205 * <p>When using implicit intents, given such an arbitrary intent we need to
206 * know what to do with it. This is handled by the process of <em>Intent
207 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
208 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
209 * more activities/receivers) that can handle it.</p>
210 *
211 * <p>The intent resolution mechanism basically revolves around matching an
212 * Intent against all of the &lt;intent-filter&gt; descriptions in the
213 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
214 * objects explicitly registered with {@link Context#registerReceiver}.) More
215 * details on this can be found in the documentation on the {@link
216 * IntentFilter} class.</p>
217 *
218 * <p>There are three pieces of information in the Intent that are used for
219 * resolution: the action, type, and category. Using this information, a query
220 * is done on the {@link PackageManager} for a component that can handle the
221 * intent. The appropriate component is determined based on the intent
222 * information supplied in the <code>AndroidManifest.xml</code> file as
223 * follows:</p>
224 *
225 * <ul>
226 * <li> <p>The <b>action</b>, if given, must be listed by the component as
227 * one it handles.</p>
228 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
229 * already supplied in the Intent. Like the action, if a type is
230 * included in the intent (either explicitly or implicitly in its
231 * data), then this must be listed by the component as one it handles.</p>
232 * <li> For data that is not a <code>content:</code> URI and where no explicit
233 * type is included in the Intent, instead the <b>scheme</b> of the
234 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
235 * considered. Again like the action, if we are matching a scheme it
236 * must be listed by the component as one it can handle.
237 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
238 * by the activity as categories it handles. That is, if you include
239 * the categories {@link #CATEGORY_LAUNCHER} and
240 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
241 * with an intent that lists <em>both</em> of those categories.
242 * Activities will very often need to support the
243 * {@link #CATEGORY_DEFAULT} so that they can be found by
244 * {@link Context#startActivity Context.startActivity()}.</p>
245 * </ul>
246 *
247 * <p>For example, consider the Note Pad sample application that
248 * allows user to browse through a list of notes data and view details about
249 * individual items. Text in italics indicate places were you would replace a
250 * name with one specific to your own package.</p>
251 *
252 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
253 * package="<i>com.android.notepad</i>"&gt;
254 * &lt;application android:icon="@drawable/app_notes"
255 * android:label="@string/app_name"&gt;
256 *
257 * &lt;provider class=".NotePadProvider"
258 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
259 *
260 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
261 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700262 * &lt;action android:name="android.intent.action.MAIN" /&gt;
263 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700264 * &lt;/intent-filter&gt;
265 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700266 * &lt;action android:name="android.intent.action.VIEW" /&gt;
267 * &lt;action android:name="android.intent.action.EDIT" /&gt;
268 * &lt;action android:name="android.intent.action.PICK" /&gt;
269 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
270 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700271 * &lt;/intent-filter&gt;
272 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
274 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
275 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700276 * &lt;/intent-filter&gt;
277 * &lt;/activity&gt;
278 *
279 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
280 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="android.intent.action.VIEW" /&gt;
282 * &lt;action android:name="android.intent.action.EDIT" /&gt;
283 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
284 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700285 * &lt;/intent-filter&gt;
286 *
287 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700288 * &lt;action android:name="android.intent.action.INSERT" /&gt;
289 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
290 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700291 * &lt;/intent-filter&gt;
292 *
293 * &lt;/activity&gt;
294 *
295 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
296 * android:theme="@android:style/Theme.Dialog"&gt;
297 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
299 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
300 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
301 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
302 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700303 * &lt;/intent-filter&gt;
304 * &lt;/activity&gt;
305 *
306 * &lt;/application&gt;
307 * &lt;/manifest&gt;</pre>
308 *
309 * <p>The first activity,
310 * <code>com.android.notepad.NotesList</code>, serves as our main
311 * entry into the app. It can do three things as described by its three intent
312 * templates:
313 * <ol>
314 * <li><pre>
315 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700316 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
317 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700318 * &lt;/intent-filter&gt;</pre>
319 * <p>This provides a top-level entry into the NotePad application: the standard
320 * MAIN action is a main entry point (not requiring any other information in
321 * the Intent), and the LAUNCHER category says that this entry point should be
322 * listed in the application launcher.</p>
323 * <li><pre>
324 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700325 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
326 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
327 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
328 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
329 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700330 * &lt;/intent-filter&gt;</pre>
331 * <p>This declares the things that the activity can do on a directory of
332 * notes. The type being supported is given with the &lt;type&gt; tag, where
333 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
334 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
335 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
336 * The activity allows the user to view or edit the directory of data (via
337 * the VIEW and EDIT actions), or to pick a particular note and return it
338 * to the caller (via the PICK action). Note also the DEFAULT category
339 * supplied here: this is <em>required</em> for the
340 * {@link Context#startActivity Context.startActivity} method to resolve your
341 * activity when its component name is not explicitly specified.</p>
342 * <li><pre>
343 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700344 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
345 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
346 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700347 * &lt;/intent-filter&gt;</pre>
348 * <p>This filter describes the ability return to the caller a note selected by
349 * the user without needing to know where it came from. The data type
350 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
351 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
352 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
353 * The GET_CONTENT action is similar to the PICK action, where the activity
354 * will return to its caller a piece of data selected by the user. Here,
355 * however, the caller specifies the type of data they desire instead of
356 * the type of data the user will be picking from.</p>
357 * </ol>
358 *
359 * <p>Given these capabilities, the following intents will resolve to the
360 * NotesList activity:</p>
361 *
362 * <ul>
363 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
364 * activities that can be used as top-level entry points into an
365 * application.</p>
366 * <li> <p><b>{ action=android.app.action.MAIN,
367 * category=android.app.category.LAUNCHER }</b> is the actual intent
368 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700369 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700370 * data=content://com.google.provider.NotePad/notes }</b>
371 * displays a list of all the notes under
372 * "content://com.google.provider.NotePad/notes", which
373 * the user can browse through and see the details on.</p>
374 * <li> <p><b>{ action=android.app.action.PICK
375 * data=content://com.google.provider.NotePad/notes }</b>
376 * provides a list of the notes under
377 * "content://com.google.provider.NotePad/notes", from which
378 * the user can pick a note whose data URL is returned back to the caller.</p>
379 * <li> <p><b>{ action=android.app.action.GET_CONTENT
380 * type=vnd.android.cursor.item/vnd.google.note }</b>
381 * is similar to the pick action, but allows the caller to specify the
382 * kind of data they want back so that the system can find the appropriate
383 * activity to pick something of that data type.</p>
384 * </ul>
385 *
386 * <p>The second activity,
387 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
388 * note entry and allows them to edit it. It can do two things as described
389 * by its two intent templates:
390 * <ol>
391 * <li><pre>
392 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700393 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
394 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
395 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
396 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700397 * &lt;/intent-filter&gt;</pre>
398 * <p>The first, primary, purpose of this activity is to let the user interact
399 * with a single note, as decribed by the MIME type
400 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
401 * either VIEW a note or allow the user to EDIT it. Again we support the
402 * DEFAULT category to allow the activity to be launched without explicitly
403 * specifying its component.</p>
404 * <li><pre>
405 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
407 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
408 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700409 * &lt;/intent-filter&gt;</pre>
410 * <p>The secondary use of this activity is to insert a new note entry into
411 * an existing directory of notes. This is used when the user creates a new
412 * note: the INSERT action is executed on the directory of notes, causing
413 * this activity to run and have the user create the new note data which
414 * it then adds to the content provider.</p>
415 * </ol>
416 *
417 * <p>Given these capabilities, the following intents will resolve to the
418 * NoteEditor activity:</p>
419 *
420 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700421 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
423 * shows the user the content of note <var>{ID}</var>.</p>
424 * <li> <p><b>{ action=android.app.action.EDIT
425 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
426 * allows the user to edit the content of note <var>{ID}</var>.</p>
427 * <li> <p><b>{ action=android.app.action.INSERT
428 * data=content://com.google.provider.NotePad/notes }</b>
429 * creates a new, empty note in the notes list at
430 * "content://com.google.provider.NotePad/notes"
431 * and allows the user to edit it. If they keep their changes, the URI
432 * of the newly created note is returned to the caller.</p>
433 * </ul>
434 *
435 * <p>The last activity,
436 * <code>com.android.notepad.TitleEditor</code>, allows the user to
437 * edit the title of a note. This could be implemented as a class that the
438 * application directly invokes (by explicitly setting its component in
439 * the Intent), but here we show a way you can publish alternative
440 * operations on existing data:</p>
441 *
442 * <pre>
443 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700444 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
445 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
446 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
447 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
448 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700449 * &lt;/intent-filter&gt;</pre>
450 *
451 * <p>In the single intent template here, we
452 * have created our own private action called
453 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
454 * edit the title of a note. It must be invoked on a specific note
455 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
456 * view and edit actions, but here displays and edits the title contained
457 * in the note data.
458 *
459 * <p>In addition to supporting the default category as usual, our title editor
460 * also supports two other standard categories: ALTERNATIVE and
461 * SELECTED_ALTERNATIVE. Implementing
462 * these categories allows others to find the special action it provides
463 * without directly knowing about it, through the
464 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
465 * more often to build dynamic menu items with
466 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
467 * template here was also supply an explicit name for the template
468 * (via <code>android:label="@string/resolve_title"</code>) to better control
469 * what the user sees when presented with this activity as an alternative
470 * action to the data they are viewing.
471 *
472 * <p>Given these capabilities, the following intent will resolve to the
473 * TitleEditor activity:</p>
474 *
475 * <ul>
476 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
477 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
478 * displays and allows the user to edit the title associated
479 * with note <var>{ID}</var>.</p>
480 * </ul>
481 *
482 * <h3>Standard Activity Actions</h3>
483 *
484 * <p>These are the current standard actions that Intent defines for launching
485 * activities (usually through {@link Context#startActivity}. The most
486 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
487 * {@link #ACTION_EDIT}.
488 *
489 * <ul>
490 * <li> {@link #ACTION_MAIN}
491 * <li> {@link #ACTION_VIEW}
492 * <li> {@link #ACTION_ATTACH_DATA}
493 * <li> {@link #ACTION_EDIT}
494 * <li> {@link #ACTION_PICK}
495 * <li> {@link #ACTION_CHOOSER}
496 * <li> {@link #ACTION_GET_CONTENT}
497 * <li> {@link #ACTION_DIAL}
498 * <li> {@link #ACTION_CALL}
499 * <li> {@link #ACTION_SEND}
500 * <li> {@link #ACTION_SENDTO}
501 * <li> {@link #ACTION_ANSWER}
502 * <li> {@link #ACTION_INSERT}
503 * <li> {@link #ACTION_DELETE}
504 * <li> {@link #ACTION_RUN}
505 * <li> {@link #ACTION_SYNC}
506 * <li> {@link #ACTION_PICK_ACTIVITY}
507 * <li> {@link #ACTION_SEARCH}
508 * <li> {@link #ACTION_WEB_SEARCH}
509 * <li> {@link #ACTION_FACTORY_TEST}
510 * </ul>
511 *
512 * <h3>Standard Broadcast Actions</h3>
513 *
514 * <p>These are the current standard actions that Intent defines for receiving
515 * broadcasts (usually through {@link Context#registerReceiver} or a
516 * &lt;receiver&gt; tag in a manifest).
517 *
518 * <ul>
519 * <li> {@link #ACTION_TIME_TICK}
520 * <li> {@link #ACTION_TIME_CHANGED}
521 * <li> {@link #ACTION_TIMEZONE_CHANGED}
522 * <li> {@link #ACTION_BOOT_COMPLETED}
523 * <li> {@link #ACTION_PACKAGE_ADDED}
524 * <li> {@link #ACTION_PACKAGE_CHANGED}
525 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800526 * <li> {@link #ACTION_PACKAGE_RESTARTED}
527 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700528 * <li> {@link #ACTION_UID_REMOVED}
529 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700530 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700531 * <li> {@link #ACTION_POWER_DISCONNECTED}
532 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700533 * </ul>
534 *
535 * <h3>Standard Categories</h3>
536 *
537 * <p>These are the current standard categories that can be used to further
538 * clarify an Intent via {@link #addCategory}.
539 *
540 * <ul>
541 * <li> {@link #CATEGORY_DEFAULT}
542 * <li> {@link #CATEGORY_BROWSABLE}
543 * <li> {@link #CATEGORY_TAB}
544 * <li> {@link #CATEGORY_ALTERNATIVE}
545 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
546 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800547 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * <li> {@link #CATEGORY_HOME}
549 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700550 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400551 * <li> {@link #CATEGORY_CAR_DOCK}
552 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500553 * <li> {@link #CATEGORY_LE_DESK_DOCK}
554 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200555 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700556 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700557 * </ul>
558 *
559 * <h3>Standard Extra Data</h3>
560 *
561 * <p>These are the current standard fields that can be used as extra data via
562 * {@link #putExtra}.
563 *
564 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_ALARM_COUNT}
566 * <li> {@link #EXTRA_BCC}
567 * <li> {@link #EXTRA_CC}
568 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
569 * <li> {@link #EXTRA_DATA_REMOVED}
570 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500571 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
572 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800573 * <li> {@link #EXTRA_DOCK_STATE_CAR}
574 * <li> {@link #EXTRA_DOCK_STATE_DESK}
575 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
576 * <li> {@link #EXTRA_DONT_KILL_APP}
577 * <li> {@link #EXTRA_EMAIL}
578 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700579 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700581 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700583 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
585 * <li> {@link #EXTRA_REPLACING}
586 * <li> {@link #EXTRA_SHORTCUT_ICON}
587 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
588 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700589 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800590 * <li> {@link #EXTRA_SHORTCUT_NAME}
591 * <li> {@link #EXTRA_SUBJECT}
592 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700593 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800594 * <li> {@link #EXTRA_TITLE}
595 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700596 * </ul>
597 *
598 * <h3>Flags</h3>
599 *
600 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800601 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
602 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700603 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800604public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 // ---------------------------------------------------------------------
606 // ---------------------------------------------------------------------
607 // Standard intent activity actions (see action variable).
608
609 /**
610 * Activity Action: Start as a main entry point, does not expect to
611 * receive data.
612 * <p>Input: nothing
613 * <p>Output: nothing
614 */
615 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
616 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800617
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 /**
619 * Activity Action: Display the data to the user. This is the most common
620 * action performed on data -- it is the generic action you can use on
621 * a piece of data to get the most reasonable thing to occur. For example,
622 * when used on a contacts entry it will view the entry; when used on a
623 * mailto: URI it will bring up a compose window filled with the information
624 * supplied by the URI; when used with a tel: URI it will invoke the
625 * dialer.
626 * <p>Input: {@link #getData} is URI from which to retrieve data.
627 * <p>Output: nothing.
628 */
629 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
630 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800631
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700632 /**
633 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
634 * performed on a piece of data.
635 */
636 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 /**
639 * Used to indicate that some piece of data should be attached to some other
640 * place. For example, image data could be attached to a contact. It is up
641 * to the recipient to decide where the data should be attached; the intent
642 * does not specify the ultimate destination.
643 * <p>Input: {@link #getData} is URI of data to be attached.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Provide explicit editable access to the given data.
651 * <p>Input: {@link #getData} is URI of data to be edited.
652 * <p>Output: nothing.
653 */
654 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
655 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800656
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700657 /**
658 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
659 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
660 * The extras can contain type specific data to pass through to the editing/creating
661 * activity.
662 * <p>Output: The URI of the item that was picked. This must be a content:
663 * URI so that any receiver can access it.
664 */
665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
666 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800667
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700668 /**
669 * Activity Action: Pick an item from the data, returning what was selected.
670 * <p>Input: {@link #getData} is URI containing a directory of data
671 * (vnd.android.cursor.dir/*) from which to pick an item.
672 * <p>Output: The URI of the item that was picked.
673 */
674 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
675 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 /**
678 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800679 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 * <p>Output: An Intent representing the shortcut. The intent must contain three
681 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
682 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800683 * (value: ShortcutIconResource).</p>
684 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700685 * @see #EXTRA_SHORTCUT_INTENT
686 * @see #EXTRA_SHORTCUT_NAME
687 * @see #EXTRA_SHORTCUT_ICON
688 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
689 * @see android.content.Intent.ShortcutIconResource
690 */
691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
692 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
693
694 /**
695 * The name of the extra used to define the Intent of a shortcut.
696 *
697 * @see #ACTION_CREATE_SHORTCUT
698 */
699 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
700 /**
701 * The name of the extra used to define the name of a shortcut.
702 *
703 * @see #ACTION_CREATE_SHORTCUT
704 */
705 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
706 /**
707 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
708 *
709 * @see #ACTION_CREATE_SHORTCUT
710 */
711 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
712 /**
713 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
714 *
715 * @see #ACTION_CREATE_SHORTCUT
716 * @see android.content.Intent.ShortcutIconResource
717 */
718 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
719 "android.intent.extra.shortcut.ICON_RESOURCE";
720
721 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800722 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 *
724 * @see Intent#ACTION_CREATE_SHORTCUT
725 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800726 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
727 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700728 */
729 public static class ShortcutIconResource implements Parcelable {
730 /**
731 * The package name of the application containing the icon.
732 */
733 public String packageName;
734
735 /**
736 * The resource name of the icon, including package, name and type.
737 */
738 public String resourceName;
739
740 /**
741 * Creates a new ShortcutIconResource for the specified context and resource
742 * identifier.
743 *
744 * @param context The context of the application.
745 * @param resourceId The resource idenfitier for the icon.
746 * @return A new ShortcutIconResource with the specified's context package name
747 * and icon resource idenfitier.
748 */
749 public static ShortcutIconResource fromContext(Context context, int resourceId) {
750 ShortcutIconResource icon = new ShortcutIconResource();
751 icon.packageName = context.getPackageName();
752 icon.resourceName = context.getResources().getResourceName(resourceId);
753 return icon;
754 }
755
756 /**
757 * Used to read a ShortcutIconResource from a Parcel.
758 */
759 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
760 new Parcelable.Creator<ShortcutIconResource>() {
761
762 public ShortcutIconResource createFromParcel(Parcel source) {
763 ShortcutIconResource icon = new ShortcutIconResource();
764 icon.packageName = source.readString();
765 icon.resourceName = source.readString();
766 return icon;
767 }
768
769 public ShortcutIconResource[] newArray(int size) {
770 return new ShortcutIconResource[size];
771 }
772 };
773
774 /**
775 * No special parcel contents.
776 */
777 public int describeContents() {
778 return 0;
779 }
780
781 public void writeToParcel(Parcel dest, int flags) {
782 dest.writeString(packageName);
783 dest.writeString(resourceName);
784 }
785
786 @Override
787 public String toString() {
788 return resourceName;
789 }
790 }
791
792 /**
793 * Activity Action: Display an activity chooser, allowing the user to pick
794 * what they want to before proceeding. This can be used as an alternative
795 * to the standard activity picker that is displayed by the system when
796 * you try to start an activity with multiple possible matches, with these
797 * differences in behavior:
798 * <ul>
799 * <li>You can specify the title that will appear in the activity chooser.
800 * <li>The user does not have the option to make one of the matching
801 * activities a preferred activity, and all possible activities will
802 * always be shown even if one of them is currently marked as the
803 * preferred activity.
804 * </ul>
805 * <p>
806 * This action should be used when the user will naturally expect to
807 * select an activity in order to proceed. An example if when not to use
808 * it is when the user clicks on a "mailto:" link. They would naturally
809 * expect to go directly to their mail app, so startActivity() should be
810 * called directly: it will
811 * either launch the current preferred app, or put up a dialog allowing the
812 * user to pick an app to use and optionally marking that as preferred.
813 * <p>
814 * In contrast, if the user is selecting a menu item to send a picture
815 * they are viewing to someone else, there are many different things they
816 * may want to do at this point: send it through e-mail, upload it to a
817 * web service, etc. In this case the CHOOSER action should be used, to
818 * always present to the user a list of the things they can do, with a
819 * nice title given by the caller such as "Send this photo with:".
820 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700821 * If you need to grant URI permissions through a chooser, you must specify
822 * the permissions to be granted on the ACTION_CHOOSER Intent
823 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
824 * {@link #setClipData} to specify the URIs to be granted as well as
825 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
826 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
827 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700828 * As a convenience, an Intent of this form can be created with the
829 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700830 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700831 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700832 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
833 * and can optionally have a {@link #EXTRA_TITLE} field containing the
834 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700835 * <p>
836 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700837 */
838 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
839 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
840
841 /**
842 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
843 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700844 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
845 * target intent, also optionally supplying a title. If the target
846 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
847 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
848 * set in the returned chooser intent, with its ClipData set appropriately:
849 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500850 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700851 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700852 * @param target The Intent that the user will be selecting an activity
853 * to perform.
854 * @param title Optional title that will be displayed in the chooser.
855 * @return Return a new Intent object that you can hand to
856 * {@link Context#startActivity(Intent) Context.startActivity()} and
857 * related methods.
858 */
859 public static Intent createChooser(Intent target, CharSequence title) {
860 Intent intent = new Intent(ACTION_CHOOSER);
861 intent.putExtra(EXTRA_INTENT, target);
862 if (title != null) {
863 intent.putExtra(EXTRA_TITLE, title);
864 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700865
866 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700867 int permFlags = target.getFlags()
868 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
869 if (permFlags != 0) {
870 ClipData targetClipData = target.getClipData();
871 if (targetClipData == null && target.getData() != null) {
872 ClipData.Item item = new ClipData.Item(target.getData());
873 String[] mimeTypes;
874 if (target.getType() != null) {
875 mimeTypes = new String[] { target.getType() };
876 } else {
877 mimeTypes = new String[] { };
878 }
879 targetClipData = new ClipData(null, mimeTypes, item);
880 }
881 if (targetClipData != null) {
882 intent.setClipData(targetClipData);
883 intent.addFlags(permFlags);
884 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700885 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700886
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700887 return intent;
888 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700889
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700890 /**
891 * Activity Action: Allow the user to select a particular kind of data and
892 * return it. This is different than {@link #ACTION_PICK} in that here we
893 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800894 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700895 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900896 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700897 * etc.
898 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900899 * 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 -0700900 * of data, such as a person contact, you set the MIME type to the kind of
901 * data you want and launch it with {@link Context#startActivity(Intent)}.
902 * The system will then launch the best application to select that kind
903 * of data for you.
904 * <p>
905 * You may also be interested in any of a set of types of content the user
906 * can pick. For example, an e-mail application that wants to allow the
907 * user to add an attachment to an e-mail message can use this action to
908 * bring up a list of all of the types of content the user can attach.
909 * <p>
910 * In this case, you should wrap the GET_CONTENT intent with a chooser
911 * (through {@link #createChooser}), which will give the proper interface
912 * for the user to pick how to send your data and allow you to specify
913 * a prompt indicating what they are doing. You will usually specify a
914 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
915 * broad range of content types the user can select from.
916 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900917 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700918 * only pick from data that can be represented as a stream. This is
919 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
920 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800921 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900922 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800923 * is locally available on the device. For example, if this extra is set
924 * to true then an image picker should not show any pictures that are available
925 * from a remote server but not already on the local device (thus requiring
926 * they be downloaded when opened).
927 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800928 * If the caller can handle multiple returned items (the user performing
929 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
930 * to indicate this.
931 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700932 * Input: {@link #getType} is the desired MIME type to retrieve. Note
933 * that no URI is supplied in the intent, as there are no constraints on
934 * where the returned data originally comes from. You may also include the
935 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800936 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800937 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
938 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700939 * <p>
940 * Output: The URI of the item that was picked. This must be a content:
941 * URI so that any receiver can access it.
942 */
943 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
944 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
945 /**
946 * Activity Action: Dial a number as specified by the data. This shows a
947 * UI with the number being dialed, allowing the user to explicitly
948 * initiate the call.
949 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
950 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
951 * number.
952 * <p>Output: nothing.
953 */
954 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
955 public static final String ACTION_DIAL = "android.intent.action.DIAL";
956 /**
957 * Activity Action: Perform a call to someone specified by the data.
958 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
959 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
960 * number.
961 * <p>Output: nothing.
962 *
963 * <p>Note: there will be restrictions on which applications can initiate a
964 * call; most applications should use the {@link #ACTION_DIAL}.
965 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
966 * numbers. Applications can <strong>dial</strong> emergency numbers using
967 * {@link #ACTION_DIAL}, however.
968 */
969 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
970 public static final String ACTION_CALL = "android.intent.action.CALL";
971 /**
972 * Activity Action: Perform a call to an emergency number specified by the
973 * data.
974 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
975 * tel: URI of an explicit phone number.
976 * <p>Output: nothing.
977 * @hide
978 */
979 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
980 /**
981 * Activity action: Perform a call to any number (emergency or not)
982 * specified by the data.
983 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
984 * tel: URI of an explicit phone number.
985 * <p>Output: nothing.
986 * @hide
987 */
988 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
989 /**
990 * Activity Action: Send a message to someone specified by the data.
991 * <p>Input: {@link #getData} is URI describing the target.
992 * <p>Output: nothing.
993 */
994 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
995 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
996 /**
997 * Activity Action: Deliver some data to someone else. Who the data is
998 * being delivered to is not specified; it is up to the receiver of this
999 * action to ask the user where the data should be sent.
1000 * <p>
1001 * When launching a SEND intent, you should usually wrap it in a chooser
1002 * (through {@link #createChooser}), which will give the proper interface
1003 * for the user to pick how to send your data and allow you to specify
1004 * a prompt indicating what they are doing.
1005 * <p>
1006 * Input: {@link #getType} is the MIME type of the data being sent.
1007 * get*Extra can have either a {@link #EXTRA_TEXT}
1008 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1009 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1010 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1011 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001012 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1013 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1014 * your text with HTML formatting.
1015 * <p>
1016 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1017 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1018 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1019 * content: URIs and other advanced features of {@link ClipData}. If
1020 * using this approach, you still must supply the same data through the
1021 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1022 * for compatibility with old applications. If you don't set a ClipData,
1023 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * <p>
1025 * Optional standard extras, which may be interpreted by some recipients as
1026 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1027 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1028 * <p>
1029 * Output: nothing.
1030 */
1031 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1032 public static final String ACTION_SEND = "android.intent.action.SEND";
1033 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001034 * Activity Action: Deliver multiple data to someone else.
1035 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001036 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001037 * <p>
1038 * Input: {@link #getType} is the MIME type of the data being sent.
1039 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001040 * #EXTRA_STREAM} field, containing the data to be sent. If using
1041 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1042 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001043 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001044 * Multiple types are supported, and receivers should handle mixed types
1045 * whenever possible. The right way for the receiver to check them is to
1046 * use the content resolver on each URI. The intent sender should try to
1047 * put the most concrete mime type in the intent type, but it can fall
1048 * back to {@literal <type>/*} or {@literal *}/* as needed.
1049 * <p>
1050 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1051 * be image/jpg, but if you are sending image/jpg and image/png, then the
1052 * intent's type should be image/*.
1053 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001054 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1055 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1056 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1057 * content: URIs and other advanced features of {@link ClipData}. If
1058 * using this approach, you still must supply the same data through the
1059 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1060 * for compatibility with old applications. If you don't set a ClipData,
1061 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1062 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001063 * Optional standard extras, which may be interpreted by some recipients as
1064 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1065 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1066 * <p>
1067 * Output: nothing.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1071 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001072 * Activity Action: Handle an incoming phone call.
1073 * <p>Input: nothing.
1074 * <p>Output: nothing.
1075 */
1076 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1077 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1078 /**
1079 * Activity Action: Insert an empty item into the given container.
1080 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1081 * in which to place the data.
1082 * <p>Output: URI of the new data that was created.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1086 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001087 * Activity Action: Create a new item in the given container, initializing it
1088 * from the current contents of the clipboard.
1089 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1090 * in which to place the data.
1091 * <p>Output: URI of the new data that was created.
1092 */
1093 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1094 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1095 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001096 * Activity Action: Delete the given data from its container.
1097 * <p>Input: {@link #getData} is URI of data to be deleted.
1098 * <p>Output: nothing.
1099 */
1100 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1101 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1102 /**
1103 * Activity Action: Run the data, whatever that means.
1104 * <p>Input: ? (Note: this is currently specific to the test harness.)
1105 * <p>Output: nothing.
1106 */
1107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1108 public static final String ACTION_RUN = "android.intent.action.RUN";
1109 /**
1110 * Activity Action: Perform a data synchronization.
1111 * <p>Input: ?
1112 * <p>Output: ?
1113 */
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1116 /**
1117 * Activity Action: Pick an activity given an intent, returning the class
1118 * selected.
1119 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1120 * used with {@link PackageManager#queryIntentActivities} to determine the
1121 * set of activities from which to pick.
1122 * <p>Output: Class name of the activity that was selected.
1123 */
1124 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1125 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1126 /**
1127 * Activity Action: Perform a search.
1128 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1129 * is the text to search for. If empty, simply
1130 * enter your search results Activity with the search UI activated.
1131 * <p>Output: nothing.
1132 */
1133 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1134 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1135 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001136 * Activity Action: Start the platform-defined tutorial
1137 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1138 * is the text to search for. If empty, simply
1139 * enter your search results Activity with the search UI activated.
1140 * <p>Output: nothing.
1141 */
1142 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1143 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1144 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001145 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001146 * <p>
1147 * Input: {@link android.app.SearchManager#QUERY
1148 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1149 * a url starts with http or https, the site will be opened. If it is plain
1150 * text, Google search will be applied.
1151 * <p>
1152 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001153 */
1154 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1155 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001156
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001157 /**
Jim Miller07994402012-05-02 14:22:27 -07001158 * Activity Action: Perform assist action.
1159 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001160 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1161 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001162 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001163 * Output: nothing.
1164 */
1165 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1166 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001167
1168 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001169 * Activity Action: Perform voice assist action.
1170 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001171 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1172 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001173 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001174 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001175 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1179
1180 /**
Adam Skory7140a252013-09-11 12:04:58 +01001181 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1182 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001183 */
1184 public static final String EXTRA_ASSIST_PACKAGE
1185 = "android.intent.extra.ASSIST_PACKAGE";
1186
1187 /**
Adam Skory7140a252013-09-11 12:04:58 +01001188 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1189 * information supplied by the current foreground app at the time of the assist request.
1190 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001191 */
1192 public static final String EXTRA_ASSIST_CONTEXT
1193 = "android.intent.extra.ASSIST_CONTEXT";
1194
Jim Miller07994402012-05-02 14:22:27 -07001195 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001196 * Activity Action: List all available applications
1197 * <p>Input: Nothing.
1198 * <p>Output: nothing.
1199 */
1200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1201 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1202 /**
1203 * Activity Action: Show settings for choosing wallpaper
1204 * <p>Input: Nothing.
1205 * <p>Output: Nothing.
1206 */
1207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1208 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1209
1210 /**
1211 * Activity Action: Show activity for reporting a bug.
1212 * <p>Input: Nothing.
1213 * <p>Output: Nothing.
1214 */
1215 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1216 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1217
1218 /**
1219 * Activity Action: Main entry point for factory tests. Only used when
1220 * the device is booting in factory test node. The implementing package
1221 * must be installed in the system image.
1222 * <p>Input: nothing
1223 * <p>Output: nothing
1224 */
1225 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1226
1227 /**
1228 * Activity Action: The user pressed the "call" button to go to the dialer
1229 * or other appropriate UI for placing a call.
1230 * <p>Input: Nothing.
1231 * <p>Output: Nothing.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1235
1236 /**
1237 * Activity Action: Start Voice Command.
1238 * <p>Input: Nothing.
1239 * <p>Output: Nothing.
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001243
1244 /**
1245 * Activity Action: Start action associated with long pressing on the
1246 * search key.
1247 * <p>Input: Nothing.
1248 * <p>Output: Nothing.
1249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001252
Jacek Surazski86b6c532009-05-13 14:38:28 +02001253 /**
1254 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1255 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001256 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001257 * <p>Input: No data is specified. The bug report is passed in using
1258 * an {@link #EXTRA_BUG_REPORT} field.
1259 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001260 *
1261 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001265
1266 /**
1267 * Activity Action: Show power usage information to the user.
1268 * <p>Input: Nothing.
1269 * <p>Output: Nothing.
1270 */
1271 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1272 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001273
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001274 /**
1275 * Activity Action: Setup wizard to launch after a platform update. This
1276 * activity should have a string meta-data field associated with it,
1277 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1278 * the platform for setup. The activity will be launched only if
1279 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1280 * same value.
1281 * <p>Input: Nothing.
1282 * <p>Output: Nothing.
1283 * @hide
1284 */
1285 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1286 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001287
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001288 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001289 * Activity Action: Show settings for managing network data usage of a
1290 * specific application. Applications should define an activity that offers
1291 * options to control data usage.
1292 */
1293 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1294 public static final String ACTION_MANAGE_NETWORK_USAGE =
1295 "android.intent.action.MANAGE_NETWORK_USAGE";
1296
1297 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001298 * Activity Action: Launch application installer.
1299 * <p>
1300 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001301 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1302 * you can also use "package:<package-name>" to install an application for the
1303 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001304 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1305 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1306 * <p>
1307 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1308 * succeeded.
1309 *
1310 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1311 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1312 * @see #EXTRA_RETURN_RESULT
1313 */
1314 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1315 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1316
1317 /**
1318 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1319 * package. Specifies the installer package name; this package will receive the
1320 * {@link #ACTION_APP_ERROR} intent.
1321 */
1322 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1323 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1324
1325 /**
1326 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1327 * package. Specifies that the application being installed should not be
1328 * treated as coming from an unknown source, but as coming from the app
1329 * invoking the Intent. For this to work you must start the installer with
1330 * startActivityForResult().
1331 */
1332 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1333 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1334
1335 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001336 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1337 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001338 * data field originated from.
1339 */
rich cannings706e8ba2012-08-20 13:20:14 -07001340 public static final String EXTRA_ORIGINATING_URI
1341 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001342
1343 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001344 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1345 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1346 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001347 */
1348 public static final String EXTRA_REFERRER
1349 = "android.intent.extra.REFERRER";
1350
1351 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001352 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1353 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1354 * @hide
1355 */
1356 public static final String EXTRA_ORIGINATING_UID
1357 = "android.intent.extra.ORIGINATING_UID";
1358
1359 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001360 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1361 * package. Tells the installer UI to skip the confirmation with the user
1362 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001363 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1364 * will no longer show an interstitial message about updating existing
1365 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001366 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001367 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001368 public static final String EXTRA_ALLOW_REPLACE
1369 = "android.intent.extra.ALLOW_REPLACE";
1370
1371 /**
1372 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1373 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1374 * return to the application the result code of the install/uninstall. The returned result
1375 * code will be {@link android.app.Activity#RESULT_OK} on success or
1376 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1377 */
1378 public static final String EXTRA_RETURN_RESULT
1379 = "android.intent.extra.RETURN_RESULT";
1380
1381 /**
1382 * Package manager install result code. @hide because result codes are not
1383 * yet ready to be exposed.
1384 */
1385 public static final String EXTRA_INSTALL_RESULT
1386 = "android.intent.extra.INSTALL_RESULT";
1387
1388 /**
1389 * Activity Action: Launch application uninstaller.
1390 * <p>
1391 * Input: The data must be a package: URI whose scheme specific part is
1392 * the package name of the current installed package to be uninstalled.
1393 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1394 * <p>
1395 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1396 * succeeded.
1397 */
1398 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1399 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1400
1401 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001402 * Specify whether the package should be uninstalled for all users.
1403 * @hide because these should not be part of normal application flow.
1404 */
1405 public static final String EXTRA_UNINSTALL_ALL_USERS
1406 = "android.intent.extra.UNINSTALL_ALL_USERS";
1407
1408 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001409 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1410 * describing the last run version of the platform that was setup.
1411 * @hide
1412 */
1413 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1414
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001415 // ---------------------------------------------------------------------
1416 // ---------------------------------------------------------------------
1417 // Standard intent broadcast actions (see action variable).
1418
1419 /**
1420 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001421 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001422 * <p class="note">This is a protected intent that can only be sent
1423 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1427 /**
1428 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001429 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001430 * <p class="note">This is a protected intent that can only be sent
1431 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001432 */
1433 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1434 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001435
1436 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001437 * Broadcast Action: Sent after the system stops dreaming.
1438 *
1439 * <p class="note">This is a protected intent that can only be sent by the system.
1440 * It is only sent to registered receivers.</p>
1441 */
1442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1443 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1444
1445 /**
1446 * Broadcast Action: Sent after the system starts dreaming.
1447 *
1448 * <p class="note">This is a protected intent that can only be sent by the system.
1449 * It is only sent to registered receivers.</p>
1450 */
1451 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1452 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1453
1454 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001455 * 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 -07001456 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001457 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001458 * <p class="note">This is a protected intent that can only be sent
1459 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001460 */
1461 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001462 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001463
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001464 /**
1465 * Broadcast Action: The current time has changed. Sent every
1466 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001467 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001468 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1469 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001470 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001471 * <p class="note">This is a protected intent that can only be sent
1472 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001473 */
1474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1475 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1476 /**
1477 * Broadcast Action: The time was set.
1478 */
1479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1480 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1481 /**
1482 * Broadcast Action: The date has changed.
1483 */
1484 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1485 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1486 /**
1487 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1488 * <ul>
1489 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1490 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001491 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001492 * <p class="note">This is a protected intent that can only be sent
1493 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001494 */
1495 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1496 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1497 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001498 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1499 * DNS entries should be tossed.
1500 * @hide
1501 */
1502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1503 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1504 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001505 * Alarm Changed Action: This is broadcast when the AlarmClock
1506 * application's alarm is set or unset. It is used by the
1507 * AlarmClock application and the StatusBar service.
1508 * @hide
1509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1512 /**
1513 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1514 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1515 * @hide
1516 */
1517 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1518 public static final String ACTION_SYNC_STATE_CHANGED
1519 = "android.intent.action.SYNC_STATE_CHANGED";
1520 /**
1521 * Broadcast Action: This is broadcast once, after the system has finished
1522 * booting. It can be used to perform application-specific initialization,
1523 * such as installing alarms. You must hold the
1524 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1525 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001526 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001527 * <p class="note">This is a protected intent that can only be sent
1528 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001529 */
1530 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1531 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1532 /**
1533 * Broadcast Action: This is broadcast when a user action should request a
1534 * temporary system dialog to dismiss. Some examples of temporary system
1535 * dialogs are the notification window-shade and the recent tasks dialog.
1536 */
1537 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1538 /**
1539 * Broadcast Action: Trigger the download and eventual installation
1540 * of a package.
1541 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001542 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001543 * <p class="note">This is a protected intent that can only be sent
1544 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001545 *
1546 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001547 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001548 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001549 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1550 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1551 /**
1552 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001553 * device. The data contains the name of the package. Note that the
1554 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001555 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001556 * <ul>
1557 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1558 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1559 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1560 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001561 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001562 * <p class="note">This is a protected intent that can only be sent
1563 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001564 */
1565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1566 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1567 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001568 * Broadcast Action: A new version of an application package has been
1569 * installed, replacing an existing version that was previously installed.
1570 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001571 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001572 * <ul>
1573 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1574 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001575 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001576 * <p class="note">This is a protected intent that can only be sent
1577 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001578 */
1579 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1580 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1581 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001582 * Broadcast Action: A new version of your application has been installed
1583 * over an existing one. This is only sent to the application that was
1584 * replaced. It does not contain any additional data; to receive it, just
1585 * use an intent filter for this action.
1586 *
1587 * <p class="note">This is a protected intent that can only be sent
1588 * by the system.
1589 */
1590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1591 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1592 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001593 * Broadcast Action: An existing application package has been removed from
1594 * the device. The data contains the name of the package. The package
1595 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001596 * <ul>
1597 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1598 * to the package.
1599 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1600 * application -- data and code -- is being removed.
1601 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1602 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1603 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001604 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001605 * <p class="note">This is a protected intent that can only be sent
1606 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001607 */
1608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1609 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1610 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001611 * Broadcast Action: An existing application package has been completely
1612 * removed from the device. The data contains the name of the package.
1613 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1614 * {@link #EXTRA_DATA_REMOVED} is true and
1615 * {@link #EXTRA_REPLACING} is false of that broadcast.
1616 *
1617 * <ul>
1618 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1619 * to the package.
1620 * </ul>
1621 *
1622 * <p class="note">This is a protected intent that can only be sent
1623 * by the system.
1624 */
1625 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1626 public static final String ACTION_PACKAGE_FULLY_REMOVED
1627 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1628 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001629 * Broadcast Action: An existing application package has been changed (e.g.
1630 * a component has been enabled or disabled). The data contains the name of
1631 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001632 * <ul>
1633 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001634 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001635 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001636 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1637 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001638 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001639 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001640 * <p class="note">This is a protected intent that can only be sent
1641 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001642 */
1643 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1644 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1645 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001646 * @hide
1647 * Broadcast Action: Ask system services if there is any reason to
1648 * restart the given package. The data contains the name of the
1649 * package.
1650 * <ul>
1651 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1652 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1653 * </ul>
1654 *
1655 * <p class="note">This is a protected intent that can only be sent
1656 * by the system.
1657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1660 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661 * Broadcast Action: The user has restarted a package, and all of its
1662 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001663 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001664 * be removed. Note that the restarted package does <em>not</em>
1665 * receive this broadcast.
1666 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001667 * <ul>
1668 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1669 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001670 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001671 * <p class="note">This is a protected intent that can only be sent
1672 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001673 */
1674 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1675 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1676 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001677 * Broadcast Action: The user has cleared the data of a package. This should
1678 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001679 * its persistent data is erased and this broadcast sent.
1680 * Note that the cleared package does <em>not</em>
1681 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 * <ul>
1683 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1684 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001685 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001686 * <p class="note">This is a protected intent that can only be sent
1687 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001688 */
1689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1690 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1691 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001692 * Broadcast Action: A user ID has been removed from the system. The user
1693 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001694 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001695 * <p class="note">This is a protected intent that can only be sent
1696 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001697 */
1698 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1699 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001700
1701 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001702 * Broadcast Action: Sent to the installer package of an application
1703 * when that application is first launched (that is the first time it
1704 * is moved out of the stopped state). The data contains the name of the package.
1705 *
1706 * <p class="note">This is a protected intent that can only be sent
1707 * by the system.
1708 */
1709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1710 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1711
1712 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001713 * Broadcast Action: Sent to the system package verifier when a package
1714 * needs to be verified. The data contains the package URI.
1715 * <p class="note">
1716 * This is a protected intent that can only be sent by the system.
1717 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001718 */
1719 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1720 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1721
1722 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001723 * Broadcast Action: Sent to the system package verifier when a package is
1724 * verified. The data contains the package URI.
1725 * <p class="note">
1726 * This is a protected intent that can only be sent by the system.
1727 */
1728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1729 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1730
1731 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001732 * Broadcast Action: Resources for a set of packages (which were
1733 * previously unavailable) are currently
1734 * available since the media on which they exist is available.
1735 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1736 * list of packages whose availability changed.
1737 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1738 * list of uids of packages whose availability changed.
1739 * Note that the
1740 * packages in this list do <em>not</em> receive this broadcast.
1741 * The specified set of packages are now available on the system.
1742 * <p>Includes the following extras:
1743 * <ul>
1744 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1745 * whose resources(were previously unavailable) are currently available.
1746 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1747 * packages whose resources(were previously unavailable)
1748 * are currently available.
1749 * </ul>
1750 *
1751 * <p class="note">This is a protected intent that can only be sent
1752 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001753 */
1754 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001755 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1756 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001757
1758 /**
1759 * Broadcast Action: Resources for a set of packages are currently
1760 * unavailable since the media on which they exist is unavailable.
1761 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1762 * list of packages whose availability changed.
1763 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1764 * list of uids of packages whose availability changed.
1765 * The specified set of packages can no longer be
1766 * launched and are practically unavailable on the system.
1767 * <p>Inclues the following extras:
1768 * <ul>
1769 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1770 * whose resources are no longer available.
1771 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1772 * whose resources are no longer available.
1773 * </ul>
1774 *
1775 * <p class="note">This is a protected intent that can only be sent
1776 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001777 */
1778 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001779 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001780 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001781
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001782 /**
1783 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001784 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001785 * This should <em>only</em> be used to determine when the wallpaper
1786 * has changed to show the new wallpaper to the user. You should certainly
1787 * never, in response to this, change the wallpaper or other attributes of
1788 * it such as the suggested size. That would be crazy, right? You'd cause
1789 * all kinds of loops, especially if other apps are doing similar things,
1790 * right? Of course. So please don't do this.
1791 *
1792 * @deprecated Modern applications should use
1793 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1794 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1795 * shown behind their UI, rather than watching for this broadcast and
1796 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001797 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001798 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001799 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1800 /**
1801 * Broadcast Action: The current device {@link android.content.res.Configuration}
1802 * (orientation, locale, etc) has changed. When such a change happens, the
1803 * UIs (view hierarchy) will need to be rebuilt based on this new
1804 * information; for the most part, applications don't need to worry about
1805 * this, because the system will take care of stopping and restarting the
1806 * application to make sure it sees the new changes. Some system code that
1807 * can not be restarted will need to watch for this action and handle it
1808 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001809 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001810 * <p class="note">
1811 * You can <em>not</em> receive this through components declared
1812 * in manifests, only by explicitly registering for it with
1813 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1814 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001815 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001816 * <p class="note">This is a protected intent that can only be sent
1817 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 *
1819 * @see android.content.res.Configuration
1820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1822 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1823 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001824 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001825 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001826 * <p class="note">This is a protected intent that can only be sent
1827 * by the system.
1828 */
1829 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1830 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1831 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001832 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1833 * charging state, level, and other information about the battery.
1834 * See {@link android.os.BatteryManager} for documentation on the
1835 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001836 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001837 * <p class="note">
1838 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001839 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001841 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1842 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1843 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1844 * broadcasts that are sent and can be received through manifest
1845 * receivers.
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_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1852 /**
1853 * Broadcast Action: Indicates low battery condition on the device.
1854 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001855 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001856 * <p class="note">This is a protected intent that can only be sent
1857 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1861 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001862 * Broadcast Action: Indicates the battery is now okay after being low.
1863 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1864 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001865 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001866 * <p class="note">This is a protected intent that can only be sent
1867 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001868 */
1869 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1870 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1871 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001872 * Broadcast Action: External power has been connected to the device.
1873 * This is intended for applications that wish to register specifically to this notification.
1874 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1875 * stay active to receive this notification. This action can be used to implement actions
1876 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001877 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001878 * <p class="note">This is a protected intent that can only be sent
1879 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001882 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001883 /**
1884 * Broadcast Action: External power has been removed from the device.
1885 * This is intended for applications that wish to register specifically to this notification.
1886 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1887 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001888 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001889 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001890 * <p class="note">This is a protected intent that can only be sent
1891 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001892 */
1893 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001894 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001895 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001896 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001897 * Broadcast Action: Device is shutting down.
1898 * This is broadcast when the device is being shut down (completely turned
1899 * off, not sleeping). Once the broadcast is complete, the final shutdown
1900 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001901 * to handle this, since the foreground activity will be paused as well.
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.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001905 * <p>May include the following extras:
1906 * <ul>
1907 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1908 * shutdown is only for userspace processes. If not set, assumed to be false.
1909 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001912 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001913 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001914 * Activity Action: Start this activity to request system shutdown.
1915 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1916 * to request confirmation from the user before shutting down.
1917 *
1918 * <p class="note">This is a protected intent that can only be sent
1919 * by the system.
1920 *
1921 * {@hide}
1922 */
1923 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1924 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001925 * Broadcast Action: A sticky broadcast that indicates low memory
1926 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001927 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001928 * <p class="note">This is a protected intent that can only be sent
1929 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 */
1931 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1932 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1933 /**
1934 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001935 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1940 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1941 /**
Jake Hambybb371632010-08-23 18:16:48 -07001942 * Broadcast Action: A sticky broadcast that indicates a memory full
1943 * condition on the device. This is intended for activities that want
1944 * to be able to fill the data partition completely, leaving only
1945 * enough free space to prevent system-wide SQLite failures.
1946 *
1947 * <p class="note">This is a protected intent that can only be sent
1948 * by the system.
1949 *
1950 * {@hide}
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1954 /**
1955 * Broadcast Action: Indicates memory full condition on the device
1956 * no longer exists.
1957 *
1958 * <p class="note">This is a protected intent that can only be sent
1959 * by the system.
1960 *
1961 * {@hide}
1962 */
1963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1964 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1965 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001966 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1967 * and package management should be started.
1968 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1969 * notification.
1970 */
1971 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1972 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1973 /**
1974 * Broadcast Action: The device has entered USB Mass Storage mode.
1975 * This is used mainly for the USB Settings panel.
1976 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1977 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001978 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001980 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1982
1983 /**
1984 * Broadcast Action: The device has exited USB Mass Storage mode.
1985 * This is used mainly for the USB Settings panel.
1986 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1987 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001988 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001989 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001990 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001991 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1992
1993 /**
1994 * Broadcast Action: External media has been removed.
1995 * The path to the mount point for the removed media is contained in the Intent.mData field.
1996 */
1997 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1998 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1999
2000 /**
2001 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002002 * 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 -07002003 */
2004 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2005 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2006
2007 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002008 * Broadcast Action: External media is present, and being disk-checked
2009 * 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 -08002010 */
2011 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2012 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2013
2014 /**
2015 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2016 * 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 -08002017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2020
2021 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002023 * 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 -07002024 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2025 * media was mounted read only.
2026 */
2027 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2028 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2029
2030 /**
2031 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002032 * 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 -07002033 */
2034 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2035 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2036
2037 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002038 * Broadcast Action: External media is no longer being shared via USB mass storage.
2039 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2040 *
2041 * @hide
2042 */
2043 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2044
2045 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002046 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2047 * The path to the mount point for the removed media is contained in the Intent.mData field.
2048 */
2049 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2050 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2051
2052 /**
2053 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002054 * 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 -07002055 */
2056 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2057 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2058
2059 /**
2060 * Broadcast Action: User has expressed the desire to remove the external storage media.
2061 * Applications should close all files they have open within the mount point when they receive this intent.
2062 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2063 */
2064 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2065 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2066
2067 /**
2068 * Broadcast Action: The media scanner has started scanning a directory.
2069 * The path to the directory being scanned is contained in the Intent.mData field.
2070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2072 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2073
2074 /**
2075 * Broadcast Action: The media scanner has finished scanning a directory.
2076 * The path to the scanned directory is contained in the Intent.mData field.
2077 */
2078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2079 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2080
2081 /**
2082 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2083 * The path to the file is contained in the Intent.mData field.
2084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2087
2088 /**
2089 * Broadcast Action: The "Media Button" was pressed. Includes a single
2090 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2091 * caused the broadcast.
2092 */
2093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2095
2096 /**
2097 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2098 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2099 * caused the broadcast.
2100 */
2101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2102 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2103
2104 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2105 // location; they are not general-purpose actions.
2106
2107 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002108 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2112 "android.intent.action.GTALK_CONNECTED";
2113
2114 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002115 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116 */
2117 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2118 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2119 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002120
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002121 /**
2122 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_INPUT_METHOD_CHANGED =
2126 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127
2128 /**
2129 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2130 * more radios have been turned off or on. The intent will have the following extra value:</p>
2131 * <ul>
2132 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2133 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2134 * turned off</li>
2135 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002136 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002137 * <p class="note">This is a protected intent that can only be sent
2138 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002139 */
2140 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2141 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2142
2143 /**
2144 * Broadcast Action: Some content providers have parts of their namespace
2145 * where they publish new events or items that the user may be especially
2146 * interested in. For these things, they may broadcast this action when the
2147 * set of interesting items change.
2148 *
2149 * For example, GmailProvider sends this notification when the set of unread
2150 * mail in the inbox changes.
2151 *
2152 * <p>The data of the intent identifies which part of which provider
2153 * changed. When queried through the content resolver, the data URI will
2154 * return the data set in question.
2155 *
2156 * <p>The intent will have the following extra values:
2157 * <ul>
2158 * <li><em>count</em> - The number of items in the data set. This is the
2159 * same as the number of items in the cursor returned by querying the
2160 * data URI. </li>
2161 * </ul>
2162 *
2163 * This intent will be sent at boot (if the count is non-zero) and when the
2164 * data set changes. It is possible for the data set to change without the
2165 * count changing (for example, if a new unread message arrives in the same
2166 * sync operation in which a message is archived). The phone should still
2167 * ring/vibrate/etc as normal in this case.
2168 */
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170 public static final String ACTION_PROVIDER_CHANGED =
2171 "android.intent.action.PROVIDER_CHANGED";
2172
2173 /**
2174 * Broadcast Action: Wired Headset plugged in or unplugged.
2175 *
2176 * <p>The intent will have the following extra values:
2177 * <ul>
2178 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2179 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002180 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002181 * </ul>
2182 * </ul>
2183 */
2184 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2185 public static final String ACTION_HEADSET_PLUG =
2186 "android.intent.action.HEADSET_PLUG";
2187
2188 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002189 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2190 *
2191 * <p>The intent will have the following extra values:
2192 * <ul>
2193 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2194 * <li><em>name</em> - Headset type, human readable string </li>
2195 * </ul>
2196 * </ul>
2197 * @hide
2198 */
2199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002200 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2201 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002202
2203 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002204 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002205 *
2206 * <p>The intent will have the following extra values:
2207 * <ul>
2208 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2209 * <li><em>name</em> - Headset type, human readable string </li>
2210 * </ul>
2211 * </ul>
2212 * @hide
2213 */
2214 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002215 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2216 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002217
2218 /**
2219 * Broadcast Action: A HMDI cable was plugged or unplugged
2220 *
2221 * <p>The intent will have the following extra values:
2222 * <ul>
2223 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2224 * <li><em>name</em> - HDMI cable, human readable string </li>
2225 * </ul>
2226 * </ul>
2227 * @hide
2228 */
2229 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2230 public static final String ACTION_HDMI_AUDIO_PLUG =
2231 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002232
2233 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002234 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2235 *
2236 * <p>The intent will have the following extra values:
2237 * <ul>
2238 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2239 * <li><em>card</em> - ALSA card number (integer) </li>
2240 * <li><em>device</em> - ALSA device number (integer) </li>
2241 * </ul>
2242 * </ul>
2243 * @hide
2244 */
2245 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2246 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2247 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2248
2249 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002250 * Broadcast Action: A USB audio device was plugged in or unplugged.
2251 *
2252 * <p>The intent will have the following extra values:
2253 * <ul>
2254 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2255 * <li><em>card</em> - ALSA card number (integer) </li>
2256 * <li><em>device</em> - ALSA device number (integer) </li>
2257 * </ul>
2258 * </ul>
2259 * @hide
2260 */
2261 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2262 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2263 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2264
2265 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002266 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2267 * <ul>
2268 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2269 * </ul>
2270 *
2271 * <p class="note">This is a protected intent that can only be sent
2272 * by the system.
2273 *
2274 * @hide
2275 */
2276 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2277 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2278 = "android.intent.action.ADVANCED_SETTINGS";
2279
2280 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002281 * Broadcast Action: An outgoing call is about to be placed.
2282 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002283 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002284 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002285 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002286 * the phone number originally intended to be dialed.</li>
2287 * </ul>
2288 * <p>Once the broadcast is finished, the resultData is used as the actual
2289 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002290 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002291 * outgoing call in turn: for example, a parental control application
2292 * might verify that the user is authorized to place the call at that
2293 * time, then a number-rewriting application might add an area code if
2294 * one was not specified.</p>
2295 * <p>For consistency, any receiver whose purpose is to prohibit phone
2296 * calls should have a priority of 0, to ensure it will see the final
2297 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002298 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002299 * should have a positive priority.
2300 * Negative priorities are reserved for the system for this broadcast;
2301 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002302 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2303 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 * <p>Emergency calls cannot be intercepted using this mechanism, and
2305 * other calls cannot be modified to call emergency numbers using this
2306 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002307 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2308 * call to use their own service instead. Those apps should first prevent
2309 * the call from being placed by setting resultData to <code>null</code>
2310 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002311 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002312 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2313 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002314 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002315 * <p class="note">This is a protected intent that can only be sent
2316 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002317 */
2318 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2319 public static final String ACTION_NEW_OUTGOING_CALL =
2320 "android.intent.action.NEW_OUTGOING_CALL";
2321
2322 /**
2323 * Broadcast Action: Have the device reboot. This is only for use by
2324 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002325 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002326 * <p class="note">This is a protected intent that can only be sent
2327 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002328 */
2329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2330 public static final String ACTION_REBOOT =
2331 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002332
Wei Huang97ecc9c2009-05-11 17:44:20 -07002333 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002334 * Broadcast Action: A sticky broadcast for changes in the physical
2335 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002336 *
2337 * <p>The intent will have the following extra values:
2338 * <ul>
2339 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002340 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002341 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002342 * <p>This is intended for monitoring the current physical dock state.
2343 * See {@link android.app.UiModeManager} for the normal API dealing with
2344 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2347 public static final String ACTION_DOCK_EVENT =
2348 "android.intent.action.DOCK_EVENT";
2349
2350 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002351 * Broadcast Action: A broadcast when idle maintenance can be started.
2352 * This means that the user is not interacting with the device and is
2353 * not expected to do so soon. Typical use of the idle maintenance is
2354 * to perform somehow expensive tasks that can be postponed at a moment
2355 * when they will not degrade user experience.
2356 * <p>
2357 * <p class="note">In order to keep the device responsive in case of an
2358 * unexpected user interaction, implementations of a maintenance task
2359 * should be interruptible. In such a scenario a broadcast with action
2360 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2361 * should not do the maintenance work in
2362 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2363 * maintenance service by {@link Context#startService(Intent)}. Also
2364 * you should hold a wake lock while your maintenance service is running
2365 * to prevent the device going to sleep.
2366 * </p>
2367 * <p>
2368 * <p class="note">This is a protected intent that can only be sent by
2369 * the system.
2370 * </p>
2371 *
2372 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002373 *
2374 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002375 */
2376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2377 public static final String ACTION_IDLE_MAINTENANCE_START =
2378 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2379
2380 /**
2381 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2382 * This means that the user was not interacting with the device as a result
2383 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2384 * was sent and now the user started interacting with the device. Typical
2385 * use of the idle maintenance is to perform somehow expensive tasks that
2386 * can be postponed at a moment when they will not degrade user experience.
2387 * <p>
2388 * <p class="note">In order to keep the device responsive in case of an
2389 * unexpected user interaction, implementations of a maintenance task
2390 * should be interruptible. Hence, on receiving a broadcast with this
2391 * action, the maintenance task should be interrupted as soon as possible.
2392 * In other words, you should not do the maintenance work in
2393 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2394 * maintenance service that was started on receiving of
2395 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2396 * lock you acquired when your maintenance service started.
2397 * </p>
2398 * <p class="note">This is a protected intent that can only be sent
2399 * by the system.
2400 *
2401 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002402 *
2403 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002404 */
2405 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2406 public static final String ACTION_IDLE_MAINTENANCE_END =
2407 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2408
2409 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002410 * Broadcast Action: a remote intent is to be broadcasted.
2411 *
2412 * A remote intent is used for remote RPC between devices. The remote intent
2413 * is serialized and sent from one device to another device. The receiving
2414 * device parses the remote intent and broadcasts it. Note that anyone can
2415 * broadcast a remote intent. However, if the intent receiver of the remote intent
2416 * does not trust intent broadcasts from arbitrary intent senders, it should require
2417 * the sender to hold certain permissions so only trusted sender's broadcast will be
2418 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002419 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002420 */
2421 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002422 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002423
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002424 /**
2425 * Broadcast Action: hook for permforming cleanup after a system update.
2426 *
2427 * The broadcast is sent when the system is booting, before the
2428 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2429 * image. A receiver for this should do its work and then disable itself
2430 * so that it does not get run again at the next boot.
2431 * @hide
2432 */
2433 public static final String ACTION_PRE_BOOT_COMPLETED =
2434 "android.intent.action.PRE_BOOT_COMPLETED";
2435
Amith Yamasani13593602012-03-22 16:16:17 -07002436 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002437 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002438 * on restricted users. The broadcast intent contains an extra
2439 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2440 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2441 * String[] depending on the restriction type.<p/>
2442 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002443 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2444 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2445 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002446 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2447 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002448 * @see RestrictionEntry
2449 */
2450 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2451 "android.intent.action.GET_RESTRICTION_ENTRIES";
2452
2453 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002454 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002455 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002456 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2457 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2458 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002459 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2460 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2461 * challenge.<p/>
2462 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002463 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002464 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002465 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2466 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002467
2468 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002469 * Sent the first time a user is starting, to allow system apps to
2470 * perform one time initialization. (This will not be seen by third
2471 * party applications because a newly initialized user does not have any
2472 * third party applications installed for it.) This is sent early in
2473 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002474 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2475 * broadcast, since it is part of a visible user interaction; be as quick
2476 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002477 */
2478 public static final String ACTION_USER_INITIALIZE =
2479 "android.intent.action.USER_INITIALIZE";
2480
2481 /**
2482 * Sent when a user switch is happening, causing the process's user to be
2483 * brought to the foreground. This is only sent to receivers registered
2484 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2485 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002486 * foreground. This is sent as a foreground
2487 * broadcast, since it is part of a visible user interaction; be as quick
2488 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002489 */
2490 public static final String ACTION_USER_FOREGROUND =
2491 "android.intent.action.USER_FOREGROUND";
2492
2493 /**
2494 * Sent when a user switch is happening, causing the process's user to be
2495 * sent to the background. This is only sent to receivers registered
2496 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2497 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002498 * background. This is sent as a foreground
2499 * broadcast, since it is part of a visible user interaction; be as quick
2500 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002501 */
2502 public static final String ACTION_USER_BACKGROUND =
2503 "android.intent.action.USER_BACKGROUND";
2504
2505 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002506 * Broadcast sent to the system when a user is added. Carries an extra
2507 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2508 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002509 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002510 * @hide
2511 */
2512 public static final String ACTION_USER_ADDED =
2513 "android.intent.action.USER_ADDED";
2514
2515 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002516 * Broadcast sent by the system when a user is started. Carries an extra
2517 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002518 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002519 * that has been started. This is sent as a foreground
2520 * broadcast, since it is part of a visible user interaction; be as quick
2521 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002522 * @hide
2523 */
2524 public static final String ACTION_USER_STARTED =
2525 "android.intent.action.USER_STARTED";
2526
2527 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002528 * Broadcast sent when a user is in the process of starting. Carries an extra
2529 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2530 * sent to registered receivers, not manifest receivers. It is sent to all
2531 * users (including the one that is being started). You must hold
2532 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2533 * this broadcast. This is sent as a background broadcast, since
2534 * its result is not part of the primary UX flow; to safely keep track of
2535 * started/stopped state of a user you can use this in conjunction with
2536 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2537 * other user state broadcasts since those are foreground broadcasts so can
2538 * execute in a different order.
2539 * @hide
2540 */
2541 public static final String ACTION_USER_STARTING =
2542 "android.intent.action.USER_STARTING";
2543
2544 /**
2545 * Broadcast sent when a user is going to be stopped. Carries an extra
2546 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2547 * sent to registered receivers, not manifest receivers. It is sent to all
2548 * users (including the one that is being stopped). You must hold
2549 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2550 * this broadcast. The user will not stop until all receivers have
2551 * handled the broadcast. This is sent as a background broadcast, since
2552 * its result is not part of the primary UX flow; to safely keep track of
2553 * started/stopped state of a user you can use this in conjunction with
2554 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2555 * other user state broadcasts since those are foreground broadcasts so can
2556 * execute in a different order.
2557 * @hide
2558 */
2559 public static final String ACTION_USER_STOPPING =
2560 "android.intent.action.USER_STOPPING";
2561
2562 /**
2563 * Broadcast sent to the system when a user is stopped. Carries an extra
2564 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2565 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2566 * specific package. This is only sent to registered receivers, not manifest
2567 * receivers. It is sent to all running users <em>except</em> the one that
2568 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002569 * @hide
2570 */
2571 public static final String ACTION_USER_STOPPED =
2572 "android.intent.action.USER_STOPPED";
2573
2574 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002575 * 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 -07002576 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002577 * one that has been removed. The user will not be completely removed until all receivers have
2578 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002579 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002580 * @hide
2581 */
2582 public static final String ACTION_USER_REMOVED =
2583 "android.intent.action.USER_REMOVED";
2584
2585 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002586 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002587 * the userHandle of the user to become the current one. This is only sent to
2588 * registered receivers, not manifest receivers. It is sent to all running users.
2589 * You must hold
2590 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002591 * @hide
2592 */
2593 public static final String ACTION_USER_SWITCHED =
2594 "android.intent.action.USER_SWITCHED";
2595
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002596 /**
2597 * Broadcast sent to the system when a user's information changes. Carries an extra
2598 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002599 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002600 * @hide
2601 */
2602 public static final String ACTION_USER_INFO_CHANGED =
2603 "android.intent.action.USER_INFO_CHANGED";
2604
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002605 /**
2606 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2607 */
2608 public static final String ACTION_QUICK_CLOCK =
2609 "android.intent.action.QUICK_CLOCK";
2610
Michael Wright0087a142013-02-05 16:29:39 -08002611 /**
2612 * Broadcast Action: This is broadcast when a user action should request the
2613 * brightness setting dialog.
2614 * @hide
2615 */
2616 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2617 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2618
Justin Kohd378ad72013-04-01 12:18:26 -07002619 /**
2620 * Broadcast Action: A global button was pressed. Includes a single
2621 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2622 * caused the broadcast.
2623 * @hide
2624 */
2625 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2626
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002627 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002628 * Activity Action: Allow the user to select and return one or more existing
2629 * documents. When invoked, the system will display the various
2630 * {@link DocumentsProvider} instances installed on the device, letting the
2631 * user interactively navigate through them. These documents include local
2632 * media, such as photos and video, and documents provided by installed
2633 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002634 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002635 * Each document is represented as a {@code content://} URI backed by a
2636 * {@link DocumentsProvider}, which can be opened as a stream with
2637 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2638 * {@link android.provider.DocumentsContract.Document} metadata.
2639 * <p>
2640 * All selected documents are returned to the calling application with
2641 * persistable read and write permission grants. If you want to maintain
2642 * access to the documents across device reboots, you need to explicitly
2643 * take the persistable permissions using
2644 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2645 * <p>
2646 * Callers can restrict document selection to a specific kind of data, such
2647 * as photos, by setting one or more MIME types in
2648 * {@link #EXTRA_MIME_TYPES}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002649 * <p>
2650 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002651 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2652 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002653 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002654 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2655 * returned URIs can be opened with
2656 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002657 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002658 * Output: The URI of the item that was picked. This must be a
2659 * {@code content://} URI so that any receiver can access it. If multiple
2660 * documents were selected, they are returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002661 *
2662 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002663 * @see #ACTION_CREATE_DOCUMENT
2664 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002665 */
2666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2667 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2668
2669 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002670 * Activity Action: Allow the user to create a new document. When invoked,
2671 * the system will display the various {@link DocumentsProvider} instances
2672 * installed on the device, letting the user navigate through them. The
2673 * returned document may be a newly created document with no content, or it
2674 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002675 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002676 * Each document is represented as a {@code content://} URI backed by a
2677 * {@link DocumentsProvider}, which can be opened as a stream with
2678 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2679 * {@link android.provider.DocumentsContract.Document} metadata.
2680 * <p>
2681 * Callers must indicate the concrete MIME type of the document being
2682 * created by setting {@link #setType(String)}. This MIME type cannot be
2683 * changed after the document is created.
2684 * <p>
2685 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2686 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002687 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002688 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2689 * returned URIs can be opened with
2690 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002691 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002692 * Output: The URI of the item that was created. This must be a
2693 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002694 *
2695 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002696 * @see #ACTION_OPEN_DOCUMENT
2697 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002698 */
2699 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2700 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2701
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002702 // ---------------------------------------------------------------------
2703 // ---------------------------------------------------------------------
2704 // Standard intent categories (see addCategory()).
2705
2706 /**
2707 * Set if the activity should be an option for the default action
2708 * (center press) to perform on a piece of data. Setting this will
2709 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002710 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002711 * Intent when initiating an action -- it is for use in intent filters
2712 * specified in packages.
2713 */
2714 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2715 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2716 /**
2717 * Activities that can be safely invoked from a browser must support this
2718 * category. For example, if the user is viewing a web page or an e-mail
2719 * and clicks on a link in the text, the Intent generated execute that
2720 * link will require the BROWSABLE category, so that only activities
2721 * supporting this category will be considered as possible actions. By
2722 * supporting this category, you are promising that there is nothing
2723 * damaging (without user intervention) that can happen by invoking any
2724 * matching Intent.
2725 */
2726 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2727 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2728 /**
2729 * Set if the activity should be considered as an alternative action to
2730 * the data the user is currently viewing. See also
2731 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2732 * applies to the selection in a list of items.
2733 *
2734 * <p>Supporting this category means that you would like your activity to be
2735 * displayed in the set of alternative things the user can do, usually as
2736 * part of the current activity's options menu. You will usually want to
2737 * include a specific label in the &lt;intent-filter&gt; of this action
2738 * describing to the user what it does.
2739 *
2740 * <p>The action of IntentFilter with this category is important in that it
2741 * describes the specific action the target will perform. This generally
2742 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2743 * a specific name such as "com.android.camera.action.CROP. Only one
2744 * alternative of any particular action will be shown to the user, so using
2745 * a specific action like this makes sure that your alternative will be
2746 * displayed while also allowing other applications to provide their own
2747 * overrides of that particular action.
2748 */
2749 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2750 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2751 /**
2752 * Set if the activity should be considered as an alternative selection
2753 * action to the data the user has currently selected. This is like
2754 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2755 * of items from which the user can select, giving them alternatives to the
2756 * default action that will be performed on it.
2757 */
2758 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2759 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2760 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002761 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002762 */
2763 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2764 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2765 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002766 * Should be displayed in the top-level launcher.
2767 */
2768 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2769 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2770 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002771 * Indicates an activity optimized for Leanback mode, and that should
2772 * be displayed in the Leanback launcher.
2773 */
2774 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2775 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2776 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002777 * Provides information about the package it is in; typically used if
2778 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2779 * a front-door to the user without having to be shown in the all apps list.
2780 */
2781 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2782 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2783 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002784 * This is the home activity, that is the first activity that is displayed
2785 * when the device boots.
2786 */
2787 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2788 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2789 /**
2790 * This activity is a preference panel.
2791 */
2792 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2793 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2794 /**
2795 * This activity is a development preference panel.
2796 */
2797 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2798 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2799 /**
2800 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002801 */
2802 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2803 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2804 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002805 * This activity allows the user to browse and download new applications.
2806 */
2807 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2808 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2809 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002810 * This activity may be exercised by the monkey or other automated test tools.
2811 */
2812 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2813 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2814 /**
2815 * To be used as a test (not part of the normal user experience).
2816 */
2817 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2818 /**
2819 * To be used as a unit test (run through the Test Harness).
2820 */
2821 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2822 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002823 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002824 * experience).
2825 */
2826 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002827
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002828 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002829 * Used to indicate that an intent only wants URIs that can be opened with
2830 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2831 * must support at least the columns defined in {@link OpenableColumns} when
2832 * queried.
2833 *
2834 * @see #ACTION_GET_CONTENT
2835 * @see #ACTION_OPEN_DOCUMENT
2836 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002837 */
2838 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2839 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2840
2841 /**
2842 * To be used as code under test for framework instrumentation tests.
2843 */
2844 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2845 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002846 /**
2847 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002848 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2849 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002850 */
2851 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2852 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2853 /**
2854 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002855 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2856 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002857 */
2858 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2859 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002860 /**
2861 * An activity to run when device is inserted into a analog (low end) dock.
2862 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2863 * information, see {@link android.app.UiModeManager}.
2864 */
2865 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2866 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2867
2868 /**
2869 * An activity to run when device is inserted into a digital (high end) dock.
2870 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2871 * information, see {@link android.app.UiModeManager}.
2872 */
2873 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2874 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002875
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002876 /**
2877 * Used to indicate that the activity can be used in a car environment.
2878 */
2879 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2880 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002882 // ---------------------------------------------------------------------
2883 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002884 // Application launch intent categories (see addCategory()).
2885
2886 /**
2887 * Used with {@link #ACTION_MAIN} to launch the browser application.
2888 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002889 * <p>NOTE: This should not be used as the primary key of an Intent,
2890 * since it will not result in the app launching with the correct
2891 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002892 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002893 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002894 */
2895 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2896 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2897
2898 /**
2899 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2900 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002901 * <p>NOTE: This should not be used as the primary key of an Intent,
2902 * since it will not result in the app launching with the correct
2903 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002904 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002905 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002906 */
2907 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2908 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2909
2910 /**
2911 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2912 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002913 * <p>NOTE: This should not be used as the primary key of an Intent,
2914 * since it will not result in the app launching with the correct
2915 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002916 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002917 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002918 */
2919 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2920 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2921
2922 /**
2923 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2924 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002925 * <p>NOTE: This should not be used as the primary key of an Intent,
2926 * since it will not result in the app launching with the correct
2927 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002928 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002929 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002930 */
2931 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2932 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2933
2934 /**
2935 * Used with {@link #ACTION_MAIN} to launch the email application.
2936 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002937 * <p>NOTE: This should not be used as the primary key of an Intent,
2938 * since it will not result in the app launching with the correct
2939 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002940 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002941 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002942 */
2943 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2944 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2945
2946 /**
2947 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2948 * The activity should be able to view and manipulate image and video files
2949 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002950 * <p>NOTE: This should not be used as the primary key of an Intent,
2951 * since it will not result in the app launching with the correct
2952 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002953 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002954 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002955 */
2956 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2957 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2958
2959 /**
2960 * Used with {@link #ACTION_MAIN} to launch the maps application.
2961 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002962 * <p>NOTE: This should not be used as the primary key of an Intent,
2963 * since it will not result in the app launching with the correct
2964 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002965 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002966 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002967 */
2968 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2969 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2970
2971 /**
2972 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2973 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002974 * <p>NOTE: This should not be used as the primary key of an Intent,
2975 * since it will not result in the app launching with the correct
2976 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002977 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002978 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002979 */
2980 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2981 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2982
2983 /**
2984 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002985 * The activity should be able to play, browse, or manipulate music files
2986 * stored on the device.
2987 * <p>NOTE: This should not be used as the primary key of an Intent,
2988 * since it will not result in the app launching with the correct
2989 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002990 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002991 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002992 */
2993 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2994 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2995
2996 // ---------------------------------------------------------------------
2997 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002998 // Standard extra data keys.
2999
3000 /**
3001 * The initial data to place in a newly created record. Use with
3002 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3003 * fields as would be given to the underlying ContentProvider.insert()
3004 * call.
3005 */
3006 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3007
3008 /**
3009 * A constant CharSequence that is associated with the Intent, used with
3010 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3011 * this may be a styled CharSequence, so you must use
3012 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3013 * retrieve it.
3014 */
3015 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3016
3017 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003018 * A constant String that is associated with the Intent, used with
3019 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3020 * as HTML formatted text. Note that you <em>must</em> also supply
3021 * {@link #EXTRA_TEXT}.
3022 */
3023 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3024
3025 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003026 * A content: URI holding a stream of data associated with the Intent,
3027 * used with {@link #ACTION_SEND} to supply the data being sent.
3028 */
3029 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3030
3031 /**
3032 * A String[] holding e-mail addresses that should be delivered to.
3033 */
3034 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3035
3036 /**
3037 * A String[] holding e-mail addresses that should be carbon copied.
3038 */
3039 public static final String EXTRA_CC = "android.intent.extra.CC";
3040
3041 /**
3042 * A String[] holding e-mail addresses that should be blind carbon copied.
3043 */
3044 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3045
3046 /**
3047 * A constant string holding the desired subject line of a message.
3048 */
3049 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3050
3051 /**
3052 * An Intent describing the choices you would like shown with
3053 * {@link #ACTION_PICK_ACTIVITY}.
3054 */
3055 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3056
3057 /**
3058 * A CharSequence dialog title to provide to the user when used with a
3059 * {@link #ACTION_CHOOSER}.
3060 */
3061 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3062
3063 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003064 * A Parcelable[] of {@link Intent} or
3065 * {@link android.content.pm.LabeledIntent} objects as set with
3066 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3067 * a the front of the list of choices, when shown to the user with a
3068 * {@link #ACTION_CHOOSER}.
3069 */
3070 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3071
3072 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003073 * A {@link android.view.KeyEvent} object containing the event that
3074 * triggered the creation of the Intent it is in.
3075 */
3076 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3077
3078 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003079 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3080 * before shutting down.
3081 *
3082 * {@hide}
3083 */
3084 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3085
3086 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003087 * 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 -07003088 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3089 * of restarting the application.
3090 */
3091 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3092
3093 /**
3094 * A String holding the phone number originally entered in
3095 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3096 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3097 */
3098 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003099
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003100 /**
3101 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3102 * intents to supply the uid the package had been assigned. Also an optional
3103 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3104 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3105 * purpose.
3106 */
3107 public static final String EXTRA_UID = "android.intent.extra.UID";
3108
3109 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003110 * @hide String array of package names.
3111 */
3112 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3113
3114 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003115 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3116 * intents to indicate whether this represents a full uninstall (removing
3117 * both the code and its data) or a partial uninstall (leaving its data,
3118 * implying that this is an update).
3119 */
3120 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003121
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003122 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003123 * @hide
3124 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3125 * intents to indicate that at this point the package has been removed for
3126 * all users on the device.
3127 */
3128 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3129 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3130
3131 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003132 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3133 * intents to indicate that this is a replacement of the package, so this
3134 * broadcast will immediately be followed by an add broadcast for a
3135 * different version of the same package.
3136 */
3137 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003138
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003139 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003140 * Used as an int extra field in {@link android.app.AlarmManager} intents
3141 * to tell the application being invoked how many pending alarms are being
3142 * delievered with the intent. For one-shot alarms this will always be 1.
3143 * For recurring alarms, this might be greater than 1 if the device was
3144 * asleep or powered off at the time an earlier alarm would have been
3145 * delivered.
3146 */
3147 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003148
Jacek Surazski86b6c532009-05-13 14:38:28 +02003149 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003150 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3151 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003152 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3153 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003154 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3155 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3156 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003157 */
3158 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3159
3160 /**
3161 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3162 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003163 */
3164 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3165
3166 /**
3167 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3168 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003169 */
3170 public static final int EXTRA_DOCK_STATE_DESK = 1;
3171
3172 /**
3173 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3174 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003175 */
3176 public static final int EXTRA_DOCK_STATE_CAR = 2;
3177
3178 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003179 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3180 * to represent that the phone is in a analog (low end) dock.
3181 */
3182 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3183
3184 /**
3185 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3186 * to represent that the phone is in a digital (high end) dock.
3187 */
3188 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3189
3190 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003191 * Boolean that can be supplied as meta-data with a dock activity, to
3192 * indicate that the dock should take over the home key when it is active.
3193 */
3194 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003195
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003196 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003197 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3198 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003199 */
3200 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3201
3202 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003203 * Used in the extra field in the remote intent. It's astring token passed with the
3204 * remote intent.
3205 */
3206 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3207 "android.intent.extra.remote_intent_token";
3208
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003209 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003210 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003211 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003212 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003213 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003214 "android.intent.extra.changed_component_name";
3215
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003216 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003217 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003218 * and contains a string array of all of the components that have changed. If
3219 * the state of the overall package has changed, then it will contain an entry
3220 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003221 */
3222 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3223 "android.intent.extra.changed_component_name_list";
3224
3225 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003226 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003227 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3228 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003229 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003230 */
3231 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3232 "android.intent.extra.changed_package_list";
3233
3234 /**
3235 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003236 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3237 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003238 * and contains an integer array of uids of all of the components
3239 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003240 */
3241 public static final String EXTRA_CHANGED_UID_LIST =
3242 "android.intent.extra.changed_uid_list";
3243
3244 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003245 * @hide
3246 * Magic extra system code can use when binding, to give a label for
3247 * who it is that has bound to a service. This is an integer giving
3248 * a framework string resource that can be displayed to the user.
3249 */
3250 public static final String EXTRA_CLIENT_LABEL =
3251 "android.intent.extra.client_label";
3252
3253 /**
3254 * @hide
3255 * Magic extra system code can use when binding, to give a PendingIntent object
3256 * that can be launched for the user to disable the system's use of this
3257 * service.
3258 */
3259 public static final String EXTRA_CLIENT_INTENT =
3260 "android.intent.extra.client_intent";
3261
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003262 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003263 * Extra used to indicate that an intent should only return data that is on
3264 * the local device. This is a boolean extra; the default is false. If true,
3265 * an implementation should only allow the user to select data that is
3266 * already on the device, not requiring it be downloaded from a remote
3267 * service when opened.
3268 *
3269 * @see #ACTION_GET_CONTENT
3270 * @see #ACTION_OPEN_DOCUMENT
3271 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003272 */
3273 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003274 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003275
Amith Yamasani13593602012-03-22 16:16:17 -07003276 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003277 * Extra used to indicate that an intent can allow the user to select and
3278 * return multiple items. This is a boolean extra; the default is false. If
3279 * true, an implementation is allowed to present the user with a UI where
3280 * they can pick multiple items that are all returned to the caller. When
3281 * this happens, they should be returned as the {@link #getClipData()} part
3282 * of the result Intent.
3283 *
3284 * @see #ACTION_GET_CONTENT
3285 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003286 */
3287 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003288 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003289
3290 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003291 * The userHandle carried with broadcast intents related to addition, removal and switching of
3292 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003293 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3294 * @hide
3295 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003296 public static final String EXTRA_USER_HANDLE =
3297 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003298
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003299 /**
3300 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003301 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3302 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003303 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003304 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3305
3306 /**
3307 * Extra sent in the intent to the BroadcastReceiver that handles
3308 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3309 * the restrictions as key/value pairs.
3310 */
3311 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3312 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003313
Amith Yamasani86118ba2013-03-28 14:33:16 -07003314 /**
3315 * Extra used in the response from a BroadcastReceiver that handles
3316 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3317 */
3318 public static final String EXTRA_RESTRICTIONS_INTENT =
3319 "android.intent.extra.restrictions_intent";
3320
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003321 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003322 * Extra used to communicate a set of acceptable MIME types. The type of the
3323 * extra is {@code String[]}. Values may be a combination of concrete MIME
3324 * types (such as "image/png") and/or partial MIME types (such as
3325 * "audio/*").
3326 *
3327 * @see #ACTION_GET_CONTENT
3328 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003329 */
3330 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3331
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003332 /**
3333 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3334 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003335 * When this is true, hardware devices can use this information to determine that
3336 * they shouldn't do a complete shutdown of their device since this is not a
3337 * complete shutdown down to the kernel, but only user space restarting.
3338 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003339 */
3340 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3341 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3342
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003343 /**
3344 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3345 * user has set their time format preferences to the 24 hour format.
3346 *
3347 * @hide for internal use only.
3348 */
3349 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3350 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3351
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003352 // ---------------------------------------------------------------------
3353 // ---------------------------------------------------------------------
3354 // Intent flags (see mFlags variable).
3355
Tor Norbyed9273d62013-05-30 15:59:53 -07003356 /** @hide */
3357 @IntDef(flag = true,
3358 value = {FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION})
3359 @Retention(RetentionPolicy.SOURCE)
3360 public @interface GrantUriMode {}
3361
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003362 /**
3363 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003364 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003365 * specified in its ClipData. When applying to an Intent's ClipData,
3366 * all URIs as well as recursive traversals through data or other ClipData
3367 * in Intent items will be granted; only the grant flags of the top-level
3368 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003369 */
3370 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3371 /**
3372 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003373 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003374 * specified in its ClipData. When applying to an Intent's ClipData,
3375 * all URIs as well as recursive traversals through data or other ClipData
3376 * in Intent items will be granted; only the grant flags of the top-level
3377 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003378 */
3379 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3380 /**
3381 * Can be set by the caller to indicate that this Intent is coming from
3382 * a background operation, not from direct user interaction.
3383 */
3384 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3385 /**
3386 * A flag you can enable for debugging: when set, log messages will be
3387 * printed during the resolution of this intent to show you what has
3388 * been found to create the final resolved list.
3389 */
3390 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003391 /**
3392 * If set, this intent will not match any components in packages that
3393 * are currently stopped. If this is not set, then the default behavior
3394 * is to include such applications in the result.
3395 */
3396 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3397 /**
3398 * If set, this intent will always match any components in packages that
3399 * are currently stopped. This is the default behavior when
3400 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3401 * flags are set, this one wins (it allows overriding of exclude for
3402 * places where the framework may automatically set the exclude flag).
3403 */
3404 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003405
3406 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003407 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003408 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003409 * persisted across device reboots until explicitly revoked with
3410 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3411 * grant for possible persisting; the receiving application must call
3412 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3413 * actually persist.
3414 *
3415 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3416 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3417 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003418 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003419 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003420 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003421
3422 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003423 * If set, the new activity is not kept in the history stack. As soon as
3424 * the user navigates away from it, the activity is finished. This may also
3425 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3426 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003427 */
3428 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3429 /**
3430 * If set, the activity will not be launched if it is already running
3431 * at the top of the history stack.
3432 */
3433 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3434 /**
3435 * If set, this activity will become the start of a new task on this
3436 * history stack. A task (from the activity that started it to the
3437 * next task activity) defines an atomic group of activities that the
3438 * user can move to. Tasks can be moved to the foreground and background;
3439 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003440 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003441 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3442 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003443 *
3444 * <p>This flag is generally used by activities that want
3445 * to present a "launcher" style behavior: they give the user a list of
3446 * separate things that can be done, which otherwise run completely
3447 * independently of the activity launching them.
3448 *
3449 * <p>When using this flag, if a task is already running for the activity
3450 * you are now starting, then a new activity will not be started; instead,
3451 * the current task will simply be brought to the front of the screen with
3452 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3453 * to disable this behavior.
3454 *
3455 * <p>This flag can not be used when the caller is requesting a result from
3456 * the activity being launched.
3457 */
3458 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3459 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003460 * This flag is used to create a new task and launch an activity into it.
3461 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3462 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3463 * search through existing tasks for ones matching this Intent. Only if no such
3464 * task is found would a new task be created. When paired with
3465 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3466 * the search for a matching task and unconditionally start a new task.
3467 *
3468 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3469 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003470 * top-level application launcher.</strong> Used in conjunction with
3471 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3472 * behavior of bringing an existing task to the foreground. When set,
3473 * a new task is <em>always</em> started to host the Activity for the
3474 * Intent, regardless of whether there is already an existing task running
3475 * the same thing.
3476 *
3477 * <p><strong>Because the default system does not include graphical task management,
3478 * you should not use this flag unless you provide some way for a user to
3479 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003480 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003481 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3482 * creating new document tasks.
3483 *
3484 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3485 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003486 *
Scott Main7aee61f2011-02-08 11:25:01 -08003487 * <p>See
3488 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3489 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003490 *
3491 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3492 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003493 */
3494 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3495 /**
3496 * If set, and the activity being launched is already running in the
3497 * current task, then instead of launching a new instance of that activity,
3498 * all of the other activities on top of it will be closed and this Intent
3499 * will be delivered to the (now on top) old activity as a new Intent.
3500 *
3501 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3502 * If D calls startActivity() with an Intent that resolves to the component
3503 * of activity B, then C and D will be finished and B receive the given
3504 * Intent, resulting in the stack now being: A, B.
3505 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003506 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003507 * either receive the new intent you are starting here in its
3508 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003510 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3511 * the same intent, then it will be finished and re-created; for all other
3512 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3513 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003514 *
3515 * <p>This launch mode can also be used to good effect in conjunction with
3516 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3517 * of a task, it will bring any currently running instance of that task
3518 * to the foreground, and then clear it to its root state. This is
3519 * especially useful, for example, when launching an activity from the
3520 * notification manager.
3521 *
Scott Main7aee61f2011-02-08 11:25:01 -08003522 * <p>See
3523 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3524 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003525 */
3526 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3527 /**
3528 * If set and this intent is being used to launch a new activity from an
3529 * existing one, then the reply target of the existing activity will be
3530 * transfered to the new activity. This way the new activity can call
3531 * {@link android.app.Activity#setResult} and have that result sent back to
3532 * the reply target of the original activity.
3533 */
3534 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3535 /**
3536 * If set and this intent is being used to launch a new activity from an
3537 * existing one, the current activity will not be counted as the top
3538 * activity for deciding whether the new intent should be delivered to
3539 * the top instead of starting a new one. The previous activity will
3540 * be used as the top, with the assumption being that the current activity
3541 * will finish itself immediately.
3542 */
3543 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3544 /**
3545 * If set, the new activity is not kept in the list of recently launched
3546 * activities.
3547 */
3548 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3549 /**
3550 * This flag is not normally set by application code, but set for you by
3551 * the system as described in the
3552 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3553 * launchMode} documentation for the singleTask mode.
3554 */
3555 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3556 /**
3557 * If set, and this activity is either being started in a new task or
3558 * bringing to the top an existing task, then it will be launched as
3559 * the front door of the task. This will result in the application of
3560 * any affinities needed to have that task in the proper state (either
3561 * moving activities to or from it), or simply resetting that task to
3562 * its initial state if needed.
3563 */
3564 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3565 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003566 * This flag is not normally set by application code, but set for you by
3567 * the system if this activity is being launched from history
3568 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003569 */
3570 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003571 /**
3572 * If set, this marks a point in the task's activity stack that should
3573 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003574 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003575 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3576 * the user re-launching it from home), this activity and all on top of
3577 * it will be finished so that the user does not return to them, but
3578 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003579 *
Craig Mautnere1f3fa22014-01-24 18:02:10 -08003580 * <p>When this flag is assigned to the root activity all activities up
3581 * to, but not including the root activity, will be cleared. This prevents
3582 * this flag from being used to finish all activities in a task and thereby
3583 * ending the task.
3584 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003585 * <p>This is useful for cases where you have a logical break in your
3586 * application. For example, an e-mail application may have a command
3587 * to view an attachment, which launches an image view activity to
3588 * display it. This activity should be part of the e-mail application's
3589 * task, since it is a part of the task the user is involved in. However,
3590 * if the user leaves that task, and later selects the e-mail app from
3591 * home, we may like them to return to the conversation they were
3592 * viewing, not the picture attachment, since that is confusing. By
3593 * setting this flag when launching the image viewer, that viewer and
3594 * any activities it starts will be removed the next time the user returns
3595 * to mail.
3596 */
3597 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003598 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003599 * This flag is used to break out "documents" into separate tasks that can
3600 * be reached via the Recents mechanism. Such a document is any kind of
3601 * item for which an application may want to maintain multiple simultaneous
3602 * instances. Examples might be text files, web pages, spreadsheets, or
3603 * emails. Each such document will be in a separate task in the Recents list.
3604 *
3605 * <p>When set, the activity specified by this Intent will launch into a
3606 * separate task rooted at that activity. The activity launched must be
3607 * defined with {@link android.R.attr#launchMode} "standard" or "singleTop".
3608 *
3609 * <p>If FLAG_ACTIVITY_NEW_DOCUMENT is used without
3610 * {@link #FLAG_ACTIVITY_MULTIPLE_TASK} then the activity manager will
3611 * search for an existing task with a matching target activity and Intent
3612 * data URI and relaunch that task, first finishing all activities down to
3613 * the root activity and then calling the root activity's
3614 * {@link android.app.Activity#onNewIntent(Intent)} method. If no existing
3615 * task's root activity matches the Intent's data URI then a new task will
3616 * be launched with the target activity as root.
3617 *
3618 * <p>When paired with {@link #FLAG_ACTIVITY_MULTIPLE_TASK} this will
3619 * always create a new task. Thus the same document may be made to appear
3620 * more than one time in Recents.
3621 *
3622 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3623 */
3624 public static final int FLAG_ACTIVITY_NEW_DOCUMENT =
3625 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET | FLAG_ACTIVITY_NEW_TASK;
3626 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003627 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003628 * callback from occurring on the current frontmost activity before it is
3629 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003630 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003631 * <p>Typically, an activity can rely on that callback to indicate that an
3632 * explicit user action has caused their activity to be moved out of the
3633 * foreground. The callback marks an appropriate point in the activity's
3634 * lifecycle for it to dismiss any notifications that it intends to display
3635 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003636 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003637 * <p>If an activity is ever started via any non-user-driven events such as
3638 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3639 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003640 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003641 */
3642 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003643 /**
3644 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3645 * this flag will cause the launched activity to be brought to the front of its
3646 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003647 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003648 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3649 * If D calls startActivity() with an Intent that resolves to the component
3650 * of activity B, then B will be brought to the front of the history stack,
3651 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003652 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003653 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003654 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003655 */
3656 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003657 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003658 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3659 * this flag will prevent the system from applying an activity transition
3660 * animation to go to the next activity state. This doesn't mean an
3661 * animation will never run -- if another activity change happens that doesn't
3662 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003663 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003664 * when you are going to do a series of activity operations but the
3665 * animation seen by the user shouldn't be driven by the first activity
3666 * change but rather a later one.
3667 */
3668 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3669 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003670 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3671 * this flag will cause any existing task that would be associated with the
3672 * activity to be cleared before the activity is started. That is, the activity
3673 * becomes the new root of an otherwise empty task, and any old activities
3674 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3675 */
3676 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3677 /**
3678 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3679 * this flag will cause a newly launching task to be placed on top of the current
3680 * home activity task (if there is one). That is, pressing back from the task
3681 * will always return the user to home even if that was not the last activity they
3682 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3683 */
3684 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003686 * If set, when sending a broadcast only registered receivers will be
3687 * called -- no BroadcastReceiver components will be launched.
3688 */
3689 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003690 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003691 * If set, when sending a broadcast the new broadcast will replace
3692 * any existing pending broadcast that matches it. Matching is defined
3693 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3694 * true for the intents of the two broadcasts. When a match is found,
3695 * the new broadcast (and receivers associated with it) will replace the
3696 * existing one in the pending broadcast list, remaining at the same
3697 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003698 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003699 * <p>This flag is most typically used with sticky broadcasts, which
3700 * only care about delivering the most recent values of the broadcast
3701 * to their receivers.
3702 */
3703 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3704 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003705 * If set, when sending a broadcast the recipient is allowed to run at
3706 * foreground priority, with a shorter timeout interval. During normal
3707 * broadcasts the receivers are not automatically hoisted out of the
3708 * background priority class.
3709 */
3710 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3711 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003712 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3713 * They can still propagate results through to later receivers, but they can not prevent
3714 * later receivers from seeing the broadcast.
3715 */
3716 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3717 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003718 * If set, when sending a broadcast <i>before boot has completed</i> only
3719 * registered receivers will be called -- no BroadcastReceiver components
3720 * will be launched. Sticky intent state will be recorded properly even
3721 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3722 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003723 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003724 * <p>This flag is only for use by system sevices as a convenience to
3725 * avoid having to implement a more complex mechanism around detection
3726 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003727 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003728 * @hide
3729 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003730 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003731 /**
3732 * Set when this broadcast is for a boot upgrade, a special mode that
3733 * allows the broadcast to be sent before the system is ready and launches
3734 * the app process with no providers running in it.
3735 * @hide
3736 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003737 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003738
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003739 /**
3740 * @hide Flags that can't be changed with PendingIntent.
3741 */
3742 public static final int IMMUTABLE_FLAGS =
3743 FLAG_GRANT_READ_URI_PERMISSION
3744 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003745
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003746 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003747 // ---------------------------------------------------------------------
3748 // toUri() and parseUri() options.
3749
3750 /**
3751 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3752 * always has the "intent:" scheme. This syntax can be used when you want
3753 * to later disambiguate between URIs that are intended to describe an
3754 * Intent vs. all others that should be treated as raw URIs. When used
3755 * with {@link #parseUri}, any other scheme will result in a generic
3756 * VIEW action for that raw URI.
3757 */
3758 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003759
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003760 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003761
3762 private String mAction;
3763 private Uri mData;
3764 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003765 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003766 private ComponentName mComponent;
3767 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003768 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003769 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003770 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003771 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003772 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003773
3774 // ---------------------------------------------------------------------
3775
3776 /**
3777 * Create an empty intent.
3778 */
3779 public Intent() {
3780 }
3781
3782 /**
3783 * Copy constructor.
3784 */
3785 public Intent(Intent o) {
3786 this.mAction = o.mAction;
3787 this.mData = o.mData;
3788 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003789 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003790 this.mComponent = o.mComponent;
3791 this.mFlags = o.mFlags;
3792 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003793 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003794 }
3795 if (o.mExtras != null) {
3796 this.mExtras = new Bundle(o.mExtras);
3797 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003798 if (o.mSourceBounds != null) {
3799 this.mSourceBounds = new Rect(o.mSourceBounds);
3800 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003801 if (o.mSelector != null) {
3802 this.mSelector = new Intent(o.mSelector);
3803 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003804 if (o.mClipData != null) {
3805 this.mClipData = new ClipData(o.mClipData);
3806 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003807 }
3808
3809 @Override
3810 public Object clone() {
3811 return new Intent(this);
3812 }
3813
3814 private Intent(Intent o, boolean all) {
3815 this.mAction = o.mAction;
3816 this.mData = o.mData;
3817 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003818 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003819 this.mComponent = o.mComponent;
3820 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003821 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003822 }
3823 }
3824
3825 /**
3826 * Make a clone of only the parts of the Intent that are relevant for
3827 * filter matching: the action, data, type, component, and categories.
3828 */
3829 public Intent cloneFilter() {
3830 return new Intent(this, false);
3831 }
3832
3833 /**
3834 * Create an intent with a given action. All other fields (data, type,
3835 * class) are null. Note that the action <em>must</em> be in a
3836 * namespace because Intents are used globally in the system -- for
3837 * example the system VIEW action is android.intent.action.VIEW; an
3838 * application's custom action would be something like
3839 * com.google.app.myapp.CUSTOM_ACTION.
3840 *
3841 * @param action The Intent action, such as ACTION_VIEW.
3842 */
3843 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003844 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003845 }
3846
3847 /**
3848 * Create an intent with a given action and for a given data url. Note
3849 * that the action <em>must</em> be in a namespace because Intents are
3850 * used globally in the system -- for example the system VIEW action is
3851 * android.intent.action.VIEW; an application's custom action would be
3852 * something like com.google.app.myapp.CUSTOM_ACTION.
3853 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003854 * <p><em>Note: scheme and host name matching in the Android framework is
3855 * case-sensitive, unlike the formal RFC. As a result,
3856 * you should always ensure that you write your Uri with these elements
3857 * using lower case letters, and normalize any Uris you receive from
3858 * outside of Android to ensure the scheme and host is lower case.</em></p>
3859 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003860 * @param action The Intent action, such as ACTION_VIEW.
3861 * @param uri The Intent data URI.
3862 */
3863 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003864 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003865 mData = uri;
3866 }
3867
3868 /**
3869 * Create an intent for a specific component. All other fields (action, data,
3870 * type, class) are null, though they can be modified later with explicit
3871 * calls. This provides a convenient way to create an intent that is
3872 * intended to execute a hard-coded class name, rather than relying on the
3873 * system to find an appropriate class for you; see {@link #setComponent}
3874 * for more information on the repercussions of this.
3875 *
3876 * @param packageContext A Context of the application package implementing
3877 * this class.
3878 * @param cls The component class that is to be used for the intent.
3879 *
3880 * @see #setClass
3881 * @see #setComponent
3882 * @see #Intent(String, android.net.Uri , Context, Class)
3883 */
3884 public Intent(Context packageContext, Class<?> cls) {
3885 mComponent = new ComponentName(packageContext, cls);
3886 }
3887
3888 /**
3889 * Create an intent for a specific component with a specified action and data.
3890 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3891 * construct the Intent and then calling {@link #setClass} to set its
3892 * class.
3893 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003894 * <p><em>Note: scheme and host name matching in the Android framework is
3895 * case-sensitive, unlike the formal RFC. As a result,
3896 * you should always ensure that you write your Uri with these elements
3897 * using lower case letters, and normalize any Uris you receive from
3898 * outside of Android to ensure the scheme and host is lower case.</em></p>
3899 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003900 * @param action The Intent action, such as ACTION_VIEW.
3901 * @param uri The Intent data URI.
3902 * @param packageContext A Context of the application package implementing
3903 * this class.
3904 * @param cls The component class that is to be used for the intent.
3905 *
3906 * @see #Intent(String, android.net.Uri)
3907 * @see #Intent(Context, Class)
3908 * @see #setClass
3909 * @see #setComponent
3910 */
3911 public Intent(String action, Uri uri,
3912 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003913 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003914 mData = uri;
3915 mComponent = new ComponentName(packageContext, cls);
3916 }
3917
3918 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003919 * Create an intent to launch the main (root) activity of a task. This
3920 * is the Intent that is started when the application's is launched from
3921 * Home. For anything else that wants to launch an application in the
3922 * same way, it is important that they use an Intent structured the same
3923 * way, and can use this function to ensure this is the case.
3924 *
3925 * <p>The returned Intent has the given Activity component as its explicit
3926 * component, {@link #ACTION_MAIN} as its action, and includes the
3927 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3928 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3929 * to do that through {@link #addFlags(int)} on the returned Intent.
3930 *
3931 * @param mainActivity The main activity component that this Intent will
3932 * launch.
3933 * @return Returns a newly created Intent that can be used to launch the
3934 * activity as a main application entry.
3935 *
3936 * @see #setClass
3937 * @see #setComponent
3938 */
3939 public static Intent makeMainActivity(ComponentName mainActivity) {
3940 Intent intent = new Intent(ACTION_MAIN);
3941 intent.setComponent(mainActivity);
3942 intent.addCategory(CATEGORY_LAUNCHER);
3943 return intent;
3944 }
3945
3946 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003947 * Make an Intent for the main activity of an application, without
3948 * specifying a specific activity to run but giving a selector to find
3949 * the activity. This results in a final Intent that is structured
3950 * the same as when the application is launched from
3951 * Home. For anything else that wants to launch an application in the
3952 * same way, it is important that they use an Intent structured the same
3953 * way, and can use this function to ensure this is the case.
3954 *
3955 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3956 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3957 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3958 * to do that through {@link #addFlags(int)} on the returned Intent.
3959 *
3960 * @param selectorAction The action name of the Intent's selector.
3961 * @param selectorCategory The name of a category to add to the Intent's
3962 * selector.
3963 * @return Returns a newly created Intent that can be used to launch the
3964 * activity as a main application entry.
3965 *
3966 * @see #setSelector(Intent)
3967 */
3968 public static Intent makeMainSelectorActivity(String selectorAction,
3969 String selectorCategory) {
3970 Intent intent = new Intent(ACTION_MAIN);
3971 intent.addCategory(CATEGORY_LAUNCHER);
3972 Intent selector = new Intent();
3973 selector.setAction(selectorAction);
3974 selector.addCategory(selectorCategory);
3975 intent.setSelector(selector);
3976 return intent;
3977 }
3978
3979 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003980 * Make an Intent that can be used to re-launch an application's task
3981 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3982 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3983 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3984 *
3985 * @param mainActivity The activity component that is the root of the
3986 * task; this is the activity that has been published in the application's
3987 * manifest as the main launcher icon.
3988 *
3989 * @return Returns a newly created Intent that can be used to relaunch the
3990 * activity's task in its root state.
3991 */
3992 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3993 Intent intent = makeMainActivity(mainActivity);
3994 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3995 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3996 return intent;
3997 }
3998
3999 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004000 * Call {@link #parseUri} with 0 flags.
4001 * @deprecated Use {@link #parseUri} instead.
4002 */
4003 @Deprecated
4004 public static Intent getIntent(String uri) throws URISyntaxException {
4005 return parseUri(uri, 0);
4006 }
Tom Taylord4a47292009-12-21 13:59:18 -08004007
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004008 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004009 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004010 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004011 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004012 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004013 *
4014 * <p>The URI given here must not be relative -- that is, it must include
4015 * the scheme and full path.
4016 *
4017 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004018 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004019 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004020 *
4021 * @return Intent The newly created Intent object.
4022 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004023 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4024 * it bad (as parsed by the Uri class) or the Intent data within the
4025 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004026 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004027 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004028 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004029 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004030 int i = 0;
4031 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004032 // Validate intent scheme for if requested.
4033 if ((flags&URI_INTENT_SCHEME) != 0) {
4034 if (!uri.startsWith("intent:")) {
4035 Intent intent = new Intent(ACTION_VIEW);
4036 try {
4037 intent.setData(Uri.parse(uri));
4038 } catch (IllegalArgumentException e) {
4039 throw new URISyntaxException(uri, e.getMessage());
4040 }
4041 return intent;
4042 }
4043 }
Tom Taylord4a47292009-12-21 13:59:18 -08004044
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004045 // simple case
4046 i = uri.lastIndexOf("#");
4047 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4048
4049 // old format Intent URI
4050 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004051
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004052 // new format
4053 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004054 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004055
4056 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004057 String data = i >= 0 ? uri.substring(0, i) : null;
4058 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004059 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004060
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004061 // loop over contents of Intent, all name=value;
4062 while (!uri.startsWith("end", i)) {
4063 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004064 if (eq < 0) eq = i-1;
4065 int semi = uri.indexOf(';', i);
4066 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004067
4068 // action
4069 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004070 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004071 }
4072
4073 // categories
4074 else if (uri.startsWith("category=", i)) {
4075 intent.addCategory(value);
4076 }
4077
4078 // type
4079 else if (uri.startsWith("type=", i)) {
4080 intent.mType = value;
4081 }
4082
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004083 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004084 else if (uri.startsWith("launchFlags=", i)) {
4085 intent.mFlags = Integer.decode(value).intValue();
4086 }
4087
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004088 // package
4089 else if (uri.startsWith("package=", i)) {
4090 intent.mPackage = value;
4091 }
4092
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004093 // component
4094 else if (uri.startsWith("component=", i)) {
4095 intent.mComponent = ComponentName.unflattenFromString(value);
4096 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004097
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004098 // scheme
4099 else if (uri.startsWith("scheme=", i)) {
4100 scheme = value;
4101 }
4102
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004103 // source bounds
4104 else if (uri.startsWith("sourceBounds=", i)) {
4105 intent.mSourceBounds = Rect.unflattenFromString(value);
4106 }
4107
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004108 // selector
4109 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4110 intent = new Intent();
4111 }
4112
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004113 // extra
4114 else {
4115 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004116 // create Bundle if it doesn't already exist
4117 if (intent.mExtras == null) intent.mExtras = new Bundle();
4118 Bundle b = intent.mExtras;
4119 // add EXTRA
4120 if (uri.startsWith("S.", i)) b.putString(key, value);
4121 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4122 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4123 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4124 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4125 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4126 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4127 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4128 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4129 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4130 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004131
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004132 // move to the next item
4133 i = semi + 1;
4134 }
4135
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004136 if (intent != baseIntent) {
4137 // The Intent had a selector; fix it up.
4138 baseIntent.setSelector(intent);
4139 intent = baseIntent;
4140 }
4141
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004142 if (data != null) {
4143 if (data.startsWith("intent:")) {
4144 data = data.substring(7);
4145 if (scheme != null) {
4146 data = scheme + ':' + data;
4147 }
4148 }
Tom Taylord4a47292009-12-21 13:59:18 -08004149
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004150 if (data.length() > 0) {
4151 try {
4152 intent.mData = Uri.parse(data);
4153 } catch (IllegalArgumentException e) {
4154 throw new URISyntaxException(uri, e.getMessage());
4155 }
4156 }
4157 }
Tom Taylord4a47292009-12-21 13:59:18 -08004158
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004159 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004160
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004161 } catch (IndexOutOfBoundsException e) {
4162 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4163 }
4164 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004165
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004166 public static Intent getIntentOld(String uri) throws URISyntaxException {
4167 Intent intent;
4168
4169 int i = uri.lastIndexOf('#');
4170 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004171 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004172 final int intentFragmentStart = i;
4173 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004174
4175 i++;
4176
4177 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004178 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004179 i += 7;
4180 int j = uri.indexOf(')', i);
4181 action = uri.substring(i, j);
4182 i = j + 1;
4183 }
4184
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004185 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004186
4187 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004188 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004189 i += 11;
4190 int j = uri.indexOf(')', i);
4191 while (i < j) {
4192 int sep = uri.indexOf('!', i);
4193 if (sep < 0) sep = j;
4194 if (i < sep) {
4195 intent.addCategory(uri.substring(i, sep));
4196 }
4197 i = sep + 1;
4198 }
4199 i = j + 1;
4200 }
4201
4202 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004203 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004204 i += 5;
4205 int j = uri.indexOf(')', i);
4206 intent.mType = uri.substring(i, j);
4207 i = j + 1;
4208 }
4209
4210 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004211 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004212 i += 12;
4213 int j = uri.indexOf(')', i);
4214 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4215 i = j + 1;
4216 }
4217
4218 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004219 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004220 i += 10;
4221 int j = uri.indexOf(')', i);
4222 int sep = uri.indexOf('!', i);
4223 if (sep >= 0 && sep < j) {
4224 String pkg = uri.substring(i, sep);
4225 String cls = uri.substring(sep + 1, j);
4226 intent.mComponent = new ComponentName(pkg, cls);
4227 }
4228 i = j + 1;
4229 }
4230
4231 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004232 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004233 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004234
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004235 final int closeParen = uri.indexOf(')', i);
4236 if (closeParen == -1) throw new URISyntaxException(uri,
4237 "EXTRA missing trailing ')'", i);
4238
4239 while (i < closeParen) {
4240 // fetch the key value
4241 int j = uri.indexOf('=', i);
4242 if (j <= i + 1 || i >= closeParen) {
4243 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4244 }
4245 char type = uri.charAt(i);
4246 i++;
4247 String key = uri.substring(i, j);
4248 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004249
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004250 // get type-value
4251 j = uri.indexOf('!', i);
4252 if (j == -1 || j >= closeParen) j = closeParen;
4253 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4254 String value = uri.substring(i, j);
4255 i = j;
4256
4257 // create Bundle if it doesn't already exist
4258 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004259
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004260 // add item to bundle
4261 try {
4262 switch (type) {
4263 case 'S':
4264 intent.mExtras.putString(key, Uri.decode(value));
4265 break;
4266 case 'B':
4267 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4268 break;
4269 case 'b':
4270 intent.mExtras.putByte(key, Byte.parseByte(value));
4271 break;
4272 case 'c':
4273 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4274 break;
4275 case 'd':
4276 intent.mExtras.putDouble(key, Double.parseDouble(value));
4277 break;
4278 case 'f':
4279 intent.mExtras.putFloat(key, Float.parseFloat(value));
4280 break;
4281 case 'i':
4282 intent.mExtras.putInt(key, Integer.parseInt(value));
4283 break;
4284 case 'l':
4285 intent.mExtras.putLong(key, Long.parseLong(value));
4286 break;
4287 case 's':
4288 intent.mExtras.putShort(key, Short.parseShort(value));
4289 break;
4290 default:
4291 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4292 }
4293 } catch (NumberFormatException e) {
4294 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4295 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004296
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004297 char ch = uri.charAt(i);
4298 if (ch == ')') break;
4299 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4300 i++;
4301 }
4302 }
4303
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004304 if (isIntentFragment) {
4305 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4306 } else {
4307 intent.mData = Uri.parse(uri);
4308 }
Tom Taylord4a47292009-12-21 13:59:18 -08004309
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004310 if (intent.mAction == null) {
4311 // By default, if no action is specified, then use VIEW.
4312 intent.mAction = ACTION_VIEW;
4313 }
4314
4315 } else {
4316 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4317 }
4318
4319 return intent;
4320 }
4321
4322 /**
4323 * Retrieve the general action to be performed, such as
4324 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4325 * the information in the intent should be interpreted -- most importantly,
4326 * what to do with the data returned by {@link #getData}.
4327 *
4328 * @return The action of this intent or null if none is specified.
4329 *
4330 * @see #setAction
4331 */
4332 public String getAction() {
4333 return mAction;
4334 }
4335
4336 /**
4337 * Retrieve data this intent is operating on. This URI specifies the name
4338 * of the data; often it uses the content: scheme, specifying data in a
4339 * content provider. Other schemes may be handled by specific activities,
4340 * such as http: by the web browser.
4341 *
4342 * @return The URI of the data this intent is targeting or null.
4343 *
4344 * @see #getScheme
4345 * @see #setData
4346 */
4347 public Uri getData() {
4348 return mData;
4349 }
4350
4351 /**
4352 * The same as {@link #getData()}, but returns the URI as an encoded
4353 * String.
4354 */
4355 public String getDataString() {
4356 return mData != null ? mData.toString() : null;
4357 }
4358
4359 /**
4360 * Return the scheme portion of the intent's data. If the data is null or
4361 * does not include a scheme, null is returned. Otherwise, the scheme
4362 * prefix without the final ':' is returned, i.e. "http".
4363 *
4364 * <p>This is the same as calling getData().getScheme() (and checking for
4365 * null data).
4366 *
4367 * @return The scheme of this intent.
4368 *
4369 * @see #getData
4370 */
4371 public String getScheme() {
4372 return mData != null ? mData.getScheme() : null;
4373 }
4374
4375 /**
4376 * Retrieve any explicit MIME type included in the intent. This is usually
4377 * null, as the type is determined by the intent data.
4378 *
4379 * @return If a type was manually set, it is returned; else null is
4380 * returned.
4381 *
4382 * @see #resolveType(ContentResolver)
4383 * @see #setType
4384 */
4385 public String getType() {
4386 return mType;
4387 }
4388
4389 /**
4390 * Return the MIME data type of this intent. If the type field is
4391 * explicitly set, that is simply returned. Otherwise, if the data is set,
4392 * the type of that data is returned. If neither fields are set, a null is
4393 * returned.
4394 *
4395 * @return The MIME type of this intent.
4396 *
4397 * @see #getType
4398 * @see #resolveType(ContentResolver)
4399 */
4400 public String resolveType(Context context) {
4401 return resolveType(context.getContentResolver());
4402 }
4403
4404 /**
4405 * Return the MIME data type of this intent. If the type field is
4406 * explicitly set, that is simply returned. Otherwise, if the data is set,
4407 * the type of that data is returned. If neither fields are set, a null is
4408 * returned.
4409 *
4410 * @param resolver A ContentResolver that can be used to determine the MIME
4411 * type of the intent's data.
4412 *
4413 * @return The MIME type of this intent.
4414 *
4415 * @see #getType
4416 * @see #resolveType(Context)
4417 */
4418 public String resolveType(ContentResolver resolver) {
4419 if (mType != null) {
4420 return mType;
4421 }
4422 if (mData != null) {
4423 if ("content".equals(mData.getScheme())) {
4424 return resolver.getType(mData);
4425 }
4426 }
4427 return null;
4428 }
4429
4430 /**
4431 * Return the MIME data type of this intent, only if it will be needed for
4432 * intent resolution. This is not generally useful for application code;
4433 * it is used by the frameworks for communicating with back-end system
4434 * services.
4435 *
4436 * @param resolver A ContentResolver that can be used to determine the MIME
4437 * type of the intent's data.
4438 *
4439 * @return The MIME type of this intent, or null if it is unknown or not
4440 * needed.
4441 */
4442 public String resolveTypeIfNeeded(ContentResolver resolver) {
4443 if (mComponent != null) {
4444 return mType;
4445 }
4446 return resolveType(resolver);
4447 }
4448
4449 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004450 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004451 *
4452 * @param category The category to check.
4453 *
4454 * @return boolean True if the intent contains the category, else false.
4455 *
4456 * @see #getCategories
4457 * @see #addCategory
4458 */
4459 public boolean hasCategory(String category) {
4460 return mCategories != null && mCategories.contains(category);
4461 }
4462
4463 /**
4464 * Return the set of all categories in the intent. If there are no categories,
4465 * returns NULL.
4466 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004467 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004468 *
4469 * @see #hasCategory
4470 * @see #addCategory
4471 */
4472 public Set<String> getCategories() {
4473 return mCategories;
4474 }
4475
4476 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004477 * Return the specific selector associated with this Intent. If there is
4478 * none, returns null. See {@link #setSelector} for more information.
4479 *
4480 * @see #setSelector
4481 */
4482 public Intent getSelector() {
4483 return mSelector;
4484 }
4485
4486 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004487 * Return the {@link ClipData} associated with this Intent. If there is
4488 * none, returns null. See {@link #setClipData} for more information.
4489 *
John Spurlock125d1332013-11-25 11:58:37 -05004490 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004491 */
4492 public ClipData getClipData() {
4493 return mClipData;
4494 }
4495
4496 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004497 * Sets the ClassLoader that will be used when unmarshalling
4498 * any Parcelable values from the extras of this Intent.
4499 *
4500 * @param loader a ClassLoader, or null to use the default loader
4501 * at the time of unmarshalling.
4502 */
4503 public void setExtrasClassLoader(ClassLoader loader) {
4504 if (mExtras != null) {
4505 mExtras.setClassLoader(loader);
4506 }
4507 }
4508
4509 /**
4510 * Returns true if an extra value is associated with the given name.
4511 * @param name the extra's name
4512 * @return true if the given extra is present.
4513 */
4514 public boolean hasExtra(String name) {
4515 return mExtras != null && mExtras.containsKey(name);
4516 }
4517
4518 /**
4519 * Returns true if the Intent's extras contain a parcelled file descriptor.
4520 * @return true if the Intent contains a parcelled file descriptor.
4521 */
4522 public boolean hasFileDescriptors() {
4523 return mExtras != null && mExtras.hasFileDescriptors();
4524 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004525
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004526 /** @hide */
4527 public void setAllowFds(boolean allowFds) {
4528 if (mExtras != null) {
4529 mExtras.setAllowFds(allowFds);
4530 }
4531 }
4532
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004533 /**
4534 * Retrieve extended data from the intent.
4535 *
4536 * @param name The name of the desired item.
4537 *
4538 * @return the value of an item that previously added with putExtra()
4539 * or null if none was found.
4540 *
4541 * @deprecated
4542 * @hide
4543 */
4544 @Deprecated
4545 public Object getExtra(String name) {
4546 return getExtra(name, null);
4547 }
4548
4549 /**
4550 * Retrieve extended data from the intent.
4551 *
4552 * @param name The name of the desired item.
4553 * @param defaultValue the value to be returned if no value of the desired
4554 * type is stored with the given name.
4555 *
4556 * @return the value of an item that previously added with putExtra()
4557 * or the default value if none was found.
4558 *
4559 * @see #putExtra(String, boolean)
4560 */
4561 public boolean getBooleanExtra(String name, boolean defaultValue) {
4562 return mExtras == null ? defaultValue :
4563 mExtras.getBoolean(name, defaultValue);
4564 }
4565
4566 /**
4567 * Retrieve extended data from the intent.
4568 *
4569 * @param name The name of the desired item.
4570 * @param defaultValue the value to be returned if no value of the desired
4571 * type is stored with the given name.
4572 *
4573 * @return the value of an item that previously added with putExtra()
4574 * or the default value if none was found.
4575 *
4576 * @see #putExtra(String, byte)
4577 */
4578 public byte getByteExtra(String name, byte defaultValue) {
4579 return mExtras == null ? defaultValue :
4580 mExtras.getByte(name, defaultValue);
4581 }
4582
4583 /**
4584 * Retrieve extended data from the intent.
4585 *
4586 * @param name The name of the desired item.
4587 * @param defaultValue the value to be returned if no value of the desired
4588 * type is stored with the given name.
4589 *
4590 * @return the value of an item that previously added with putExtra()
4591 * or the default value if none was found.
4592 *
4593 * @see #putExtra(String, short)
4594 */
4595 public short getShortExtra(String name, short defaultValue) {
4596 return mExtras == null ? defaultValue :
4597 mExtras.getShort(name, defaultValue);
4598 }
4599
4600 /**
4601 * Retrieve extended data from the intent.
4602 *
4603 * @param name The name of the desired item.
4604 * @param defaultValue the value to be returned if no value of the desired
4605 * type is stored with the given name.
4606 *
4607 * @return the value of an item that previously added with putExtra()
4608 * or the default value if none was found.
4609 *
4610 * @see #putExtra(String, char)
4611 */
4612 public char getCharExtra(String name, char defaultValue) {
4613 return mExtras == null ? defaultValue :
4614 mExtras.getChar(name, defaultValue);
4615 }
4616
4617 /**
4618 * Retrieve extended data from the intent.
4619 *
4620 * @param name The name of the desired item.
4621 * @param defaultValue the value to be returned if no value of the desired
4622 * type is stored with the given name.
4623 *
4624 * @return the value of an item that previously added with putExtra()
4625 * or the default value if none was found.
4626 *
4627 * @see #putExtra(String, int)
4628 */
4629 public int getIntExtra(String name, int defaultValue) {
4630 return mExtras == null ? defaultValue :
4631 mExtras.getInt(name, defaultValue);
4632 }
4633
4634 /**
4635 * Retrieve extended data from the intent.
4636 *
4637 * @param name The name of the desired item.
4638 * @param defaultValue the value to be returned if no value of the desired
4639 * type is stored with the given name.
4640 *
4641 * @return the value of an item that previously added with putExtra()
4642 * or the default value if none was found.
4643 *
4644 * @see #putExtra(String, long)
4645 */
4646 public long getLongExtra(String name, long defaultValue) {
4647 return mExtras == null ? defaultValue :
4648 mExtras.getLong(name, defaultValue);
4649 }
4650
4651 /**
4652 * Retrieve extended data from the intent.
4653 *
4654 * @param name The name of the desired item.
4655 * @param defaultValue the value to be returned if no value of the desired
4656 * type is stored with the given name.
4657 *
4658 * @return the value of an item that previously added with putExtra(),
4659 * or the default value if no such item is present
4660 *
4661 * @see #putExtra(String, float)
4662 */
4663 public float getFloatExtra(String name, float defaultValue) {
4664 return mExtras == null ? defaultValue :
4665 mExtras.getFloat(name, defaultValue);
4666 }
4667
4668 /**
4669 * Retrieve extended data from the intent.
4670 *
4671 * @param name The name of the desired item.
4672 * @param defaultValue the value to be returned if no value of the desired
4673 * type is stored with the given name.
4674 *
4675 * @return the value of an item that previously added with putExtra()
4676 * or the default value if none was found.
4677 *
4678 * @see #putExtra(String, double)
4679 */
4680 public double getDoubleExtra(String name, double defaultValue) {
4681 return mExtras == null ? defaultValue :
4682 mExtras.getDouble(name, defaultValue);
4683 }
4684
4685 /**
4686 * Retrieve extended data from the intent.
4687 *
4688 * @param name The name of the desired item.
4689 *
4690 * @return the value of an item that previously added with putExtra()
4691 * or null if no String value was found.
4692 *
4693 * @see #putExtra(String, String)
4694 */
4695 public String getStringExtra(String name) {
4696 return mExtras == null ? null : mExtras.getString(name);
4697 }
4698
4699 /**
4700 * Retrieve extended data from the intent.
4701 *
4702 * @param name The name of the desired item.
4703 *
4704 * @return the value of an item that previously added with putExtra()
4705 * or null if no CharSequence value was found.
4706 *
4707 * @see #putExtra(String, CharSequence)
4708 */
4709 public CharSequence getCharSequenceExtra(String name) {
4710 return mExtras == null ? null : mExtras.getCharSequence(name);
4711 }
4712
4713 /**
4714 * Retrieve extended data from the intent.
4715 *
4716 * @param name The name of the desired item.
4717 *
4718 * @return the value of an item that previously added with putExtra()
4719 * or null if no Parcelable value was found.
4720 *
4721 * @see #putExtra(String, Parcelable)
4722 */
4723 public <T extends Parcelable> T getParcelableExtra(String name) {
4724 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4725 }
4726
4727 /**
4728 * Retrieve extended data from the intent.
4729 *
4730 * @param name The name of the desired item.
4731 *
4732 * @return the value of an item that previously added with putExtra()
4733 * or null if no Parcelable[] value was found.
4734 *
4735 * @see #putExtra(String, Parcelable[])
4736 */
4737 public Parcelable[] getParcelableArrayExtra(String name) {
4738 return mExtras == null ? null : mExtras.getParcelableArray(name);
4739 }
4740
4741 /**
4742 * Retrieve extended data from the intent.
4743 *
4744 * @param name The name of the desired item.
4745 *
4746 * @return the value of an item that previously added with putExtra()
4747 * or null if no ArrayList<Parcelable> value was found.
4748 *
4749 * @see #putParcelableArrayListExtra(String, ArrayList)
4750 */
4751 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4752 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4753 }
4754
4755 /**
4756 * Retrieve extended data from the intent.
4757 *
4758 * @param name The name of the desired item.
4759 *
4760 * @return the value of an item that previously added with putExtra()
4761 * or null if no Serializable value was found.
4762 *
4763 * @see #putExtra(String, Serializable)
4764 */
4765 public Serializable getSerializableExtra(String name) {
4766 return mExtras == null ? null : mExtras.getSerializable(name);
4767 }
4768
4769 /**
4770 * Retrieve extended data from the intent.
4771 *
4772 * @param name The name of the desired item.
4773 *
4774 * @return the value of an item that previously added with putExtra()
4775 * or null if no ArrayList<Integer> value was found.
4776 *
4777 * @see #putIntegerArrayListExtra(String, ArrayList)
4778 */
4779 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4780 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4781 }
4782
4783 /**
4784 * Retrieve extended data from the intent.
4785 *
4786 * @param name The name of the desired item.
4787 *
4788 * @return the value of an item that previously added with putExtra()
4789 * or null if no ArrayList<String> value was found.
4790 *
4791 * @see #putStringArrayListExtra(String, ArrayList)
4792 */
4793 public ArrayList<String> getStringArrayListExtra(String name) {
4794 return mExtras == null ? null : mExtras.getStringArrayList(name);
4795 }
4796
4797 /**
4798 * Retrieve extended data from the intent.
4799 *
4800 * @param name The name of the desired item.
4801 *
4802 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004803 * or null if no ArrayList<CharSequence> value was found.
4804 *
4805 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4806 */
4807 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4808 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4809 }
4810
4811 /**
4812 * Retrieve extended data from the intent.
4813 *
4814 * @param name The name of the desired item.
4815 *
4816 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004817 * or null if no boolean array value was found.
4818 *
4819 * @see #putExtra(String, boolean[])
4820 */
4821 public boolean[] getBooleanArrayExtra(String name) {
4822 return mExtras == null ? null : mExtras.getBooleanArray(name);
4823 }
4824
4825 /**
4826 * Retrieve extended data from the intent.
4827 *
4828 * @param name The name of the desired item.
4829 *
4830 * @return the value of an item that previously added with putExtra()
4831 * or null if no byte array value was found.
4832 *
4833 * @see #putExtra(String, byte[])
4834 */
4835 public byte[] getByteArrayExtra(String name) {
4836 return mExtras == null ? null : mExtras.getByteArray(name);
4837 }
4838
4839 /**
4840 * Retrieve extended data from the intent.
4841 *
4842 * @param name The name of the desired item.
4843 *
4844 * @return the value of an item that previously added with putExtra()
4845 * or null if no short array value was found.
4846 *
4847 * @see #putExtra(String, short[])
4848 */
4849 public short[] getShortArrayExtra(String name) {
4850 return mExtras == null ? null : mExtras.getShortArray(name);
4851 }
4852
4853 /**
4854 * Retrieve extended data from the intent.
4855 *
4856 * @param name The name of the desired item.
4857 *
4858 * @return the value of an item that previously added with putExtra()
4859 * or null if no char array value was found.
4860 *
4861 * @see #putExtra(String, char[])
4862 */
4863 public char[] getCharArrayExtra(String name) {
4864 return mExtras == null ? null : mExtras.getCharArray(name);
4865 }
4866
4867 /**
4868 * Retrieve extended data from the intent.
4869 *
4870 * @param name The name of the desired item.
4871 *
4872 * @return the value of an item that previously added with putExtra()
4873 * or null if no int array value was found.
4874 *
4875 * @see #putExtra(String, int[])
4876 */
4877 public int[] getIntArrayExtra(String name) {
4878 return mExtras == null ? null : mExtras.getIntArray(name);
4879 }
4880
4881 /**
4882 * Retrieve extended data from the intent.
4883 *
4884 * @param name The name of the desired item.
4885 *
4886 * @return the value of an item that previously added with putExtra()
4887 * or null if no long array value was found.
4888 *
4889 * @see #putExtra(String, long[])
4890 */
4891 public long[] getLongArrayExtra(String name) {
4892 return mExtras == null ? null : mExtras.getLongArray(name);
4893 }
4894
4895 /**
4896 * Retrieve extended data from the intent.
4897 *
4898 * @param name The name of the desired item.
4899 *
4900 * @return the value of an item that previously added with putExtra()
4901 * or null if no float array value was found.
4902 *
4903 * @see #putExtra(String, float[])
4904 */
4905 public float[] getFloatArrayExtra(String name) {
4906 return mExtras == null ? null : mExtras.getFloatArray(name);
4907 }
4908
4909 /**
4910 * Retrieve extended data from the intent.
4911 *
4912 * @param name The name of the desired item.
4913 *
4914 * @return the value of an item that previously added with putExtra()
4915 * or null if no double array value was found.
4916 *
4917 * @see #putExtra(String, double[])
4918 */
4919 public double[] getDoubleArrayExtra(String name) {
4920 return mExtras == null ? null : mExtras.getDoubleArray(name);
4921 }
4922
4923 /**
4924 * Retrieve extended data from the intent.
4925 *
4926 * @param name The name of the desired item.
4927 *
4928 * @return the value of an item that previously added with putExtra()
4929 * or null if no String array value was found.
4930 *
4931 * @see #putExtra(String, String[])
4932 */
4933 public String[] getStringArrayExtra(String name) {
4934 return mExtras == null ? null : mExtras.getStringArray(name);
4935 }
4936
4937 /**
4938 * Retrieve extended data from the intent.
4939 *
4940 * @param name The name of the desired item.
4941 *
4942 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004943 * or null if no CharSequence array value was found.
4944 *
4945 * @see #putExtra(String, CharSequence[])
4946 */
4947 public CharSequence[] getCharSequenceArrayExtra(String name) {
4948 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4949 }
4950
4951 /**
4952 * Retrieve extended data from the intent.
4953 *
4954 * @param name The name of the desired item.
4955 *
4956 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004957 * or null if no Bundle value was found.
4958 *
4959 * @see #putExtra(String, Bundle)
4960 */
4961 public Bundle getBundleExtra(String name) {
4962 return mExtras == null ? null : mExtras.getBundle(name);
4963 }
4964
4965 /**
4966 * Retrieve extended data from the intent.
4967 *
4968 * @param name The name of the desired item.
4969 *
4970 * @return the value of an item that previously added with putExtra()
4971 * or null if no IBinder value was found.
4972 *
4973 * @see #putExtra(String, IBinder)
4974 *
4975 * @deprecated
4976 * @hide
4977 */
4978 @Deprecated
4979 public IBinder getIBinderExtra(String name) {
4980 return mExtras == null ? null : mExtras.getIBinder(name);
4981 }
4982
4983 /**
4984 * Retrieve extended data from the intent.
4985 *
4986 * @param name The name of the desired item.
4987 * @param defaultValue The default value to return in case no item is
4988 * associated with the key 'name'
4989 *
4990 * @return the value of an item that previously added with putExtra()
4991 * or defaultValue if none was found.
4992 *
4993 * @see #putExtra
4994 *
4995 * @deprecated
4996 * @hide
4997 */
4998 @Deprecated
4999 public Object getExtra(String name, Object defaultValue) {
5000 Object result = defaultValue;
5001 if (mExtras != null) {
5002 Object result2 = mExtras.get(name);
5003 if (result2 != null) {
5004 result = result2;
5005 }
5006 }
5007
5008 return result;
5009 }
5010
5011 /**
5012 * Retrieves a map of extended data from the intent.
5013 *
5014 * @return the map of all extras previously added with putExtra(),
5015 * or null if none have been added.
5016 */
5017 public Bundle getExtras() {
5018 return (mExtras != null)
5019 ? new Bundle(mExtras)
5020 : null;
5021 }
5022
5023 /**
5024 * Retrieve any special flags associated with this intent. You will
5025 * normally just set them with {@link #setFlags} and let the system
5026 * take the appropriate action with them.
5027 *
5028 * @return int The currently set flags.
5029 *
5030 * @see #setFlags
5031 */
5032 public int getFlags() {
5033 return mFlags;
5034 }
5035
Dianne Hackborne7f97212011-02-24 14:40:20 -08005036 /** @hide */
5037 public boolean isExcludingStopped() {
5038 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5039 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5040 }
5041
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005042 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005043 * Retrieve the application package name this Intent is limited to. When
5044 * resolving an Intent, if non-null this limits the resolution to only
5045 * components in the given application package.
5046 *
5047 * @return The name of the application package for the Intent.
5048 *
5049 * @see #resolveActivity
5050 * @see #setPackage
5051 */
5052 public String getPackage() {
5053 return mPackage;
5054 }
5055
5056 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005057 * Retrieve the concrete component associated with the intent. When receiving
5058 * an intent, this is the component that was found to best handle it (that is,
5059 * yourself) and will always be non-null; in all other cases it will be
5060 * null unless explicitly set.
5061 *
5062 * @return The name of the application component to handle the intent.
5063 *
5064 * @see #resolveActivity
5065 * @see #setComponent
5066 */
5067 public ComponentName getComponent() {
5068 return mComponent;
5069 }
5070
5071 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005072 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5073 * used as a hint to the receiver for animations and the like. Null means that there
5074 * is no source bounds.
5075 */
5076 public Rect getSourceBounds() {
5077 return mSourceBounds;
5078 }
5079
5080 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081 * Return the Activity component that should be used to handle this intent.
5082 * The appropriate component is determined based on the information in the
5083 * intent, evaluated as follows:
5084 *
5085 * <p>If {@link #getComponent} returns an explicit class, that is returned
5086 * without any further consideration.
5087 *
5088 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5089 * category to be considered.
5090 *
5091 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5092 * action.
5093 *
5094 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5095 * this type.
5096 *
5097 * <p>If {@link #addCategory} has added any categories, the activity must
5098 * handle ALL of the categories specified.
5099 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005100 * <p>If {@link #getPackage} is non-NULL, only activity components in
5101 * that application package will be considered.
5102 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005103 * <p>If there are no activities that satisfy all of these conditions, a
5104 * null string is returned.
5105 *
5106 * <p>If multiple activities are found to satisfy the intent, the one with
5107 * the highest priority will be used. If there are multiple activities
5108 * with the same priority, the system will either pick the best activity
5109 * based on user preference, or resolve to a system class that will allow
5110 * the user to pick an activity and forward from there.
5111 *
5112 * <p>This method is implemented simply by calling
5113 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5114 * true.</p>
5115 * <p> This API is called for you as part of starting an activity from an
5116 * intent. You do not normally need to call it yourself.</p>
5117 *
5118 * @param pm The package manager with which to resolve the Intent.
5119 *
5120 * @return Name of the component implementing an activity that can
5121 * display the intent.
5122 *
5123 * @see #setComponent
5124 * @see #getComponent
5125 * @see #resolveActivityInfo
5126 */
5127 public ComponentName resolveActivity(PackageManager pm) {
5128 if (mComponent != null) {
5129 return mComponent;
5130 }
5131
5132 ResolveInfo info = pm.resolveActivity(
5133 this, PackageManager.MATCH_DEFAULT_ONLY);
5134 if (info != null) {
5135 return new ComponentName(
5136 info.activityInfo.applicationInfo.packageName,
5137 info.activityInfo.name);
5138 }
5139
5140 return null;
5141 }
5142
5143 /**
5144 * Resolve the Intent into an {@link ActivityInfo}
5145 * describing the activity that should execute the intent. Resolution
5146 * follows the same rules as described for {@link #resolveActivity}, but
5147 * you get back the completely information about the resolved activity
5148 * instead of just its class name.
5149 *
5150 * @param pm The package manager with which to resolve the Intent.
5151 * @param flags Addition information to retrieve as per
5152 * {@link PackageManager#getActivityInfo(ComponentName, int)
5153 * PackageManager.getActivityInfo()}.
5154 *
5155 * @return PackageManager.ActivityInfo
5156 *
5157 * @see #resolveActivity
5158 */
5159 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5160 ActivityInfo ai = null;
5161 if (mComponent != null) {
5162 try {
5163 ai = pm.getActivityInfo(mComponent, flags);
5164 } catch (PackageManager.NameNotFoundException e) {
5165 // ignore
5166 }
5167 } else {
5168 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005169 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005170 if (info != null) {
5171 ai = info.activityInfo;
5172 }
5173 }
5174
5175 return ai;
5176 }
5177
5178 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005179 * Special function for use by the system to resolve service
5180 * intents to system apps. Throws an exception if there are
5181 * multiple potential matches to the Intent. Returns null if
5182 * there are no matches.
5183 * @hide
5184 */
5185 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5186 if (mComponent != null) {
5187 return mComponent;
5188 }
5189
5190 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5191 if (results == null) {
5192 return null;
5193 }
5194 ComponentName comp = null;
5195 for (int i=0; i<results.size(); i++) {
5196 ResolveInfo ri = results.get(i);
5197 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5198 continue;
5199 }
5200 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5201 ri.serviceInfo.name);
5202 if (comp != null) {
5203 throw new IllegalStateException("Multiple system services handle " + this
5204 + ": " + comp + ", " + foundComp);
5205 }
5206 comp = foundComp;
5207 }
5208 return comp;
5209 }
5210
5211 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005212 * Set the general action to be performed.
5213 *
5214 * @param action An action name, such as ACTION_VIEW. Application-specific
5215 * actions should be prefixed with the vendor's package name.
5216 *
5217 * @return Returns the same Intent object, for chaining multiple calls
5218 * into a single statement.
5219 *
5220 * @see #getAction
5221 */
5222 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005223 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005224 return this;
5225 }
5226
5227 /**
5228 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005229 * clears any type that was previously set by {@link #setType} or
5230 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005231 *
Nick Pellyccae4122012-01-09 14:12:58 -08005232 * <p><em>Note: scheme matching in the Android framework is
5233 * case-sensitive, unlike the formal RFC. As a result,
5234 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005235 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005236 * {@link #setDataAndNormalize}
5237 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005238 *
Nick Pellyccae4122012-01-09 14:12:58 -08005239 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005240 *
5241 * @return Returns the same Intent object, for chaining multiple calls
5242 * into a single statement.
5243 *
5244 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005245 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005246 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005247 */
5248 public Intent setData(Uri data) {
5249 mData = data;
5250 mType = null;
5251 return this;
5252 }
5253
5254 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005255 * Normalize and set the data this intent is operating on.
5256 *
5257 * <p>This method automatically clears any type that was
5258 * previously set (for example, by {@link #setType}).
5259 *
5260 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005261 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005262 * so really this is just a convenience method for
5263 * <pre>
5264 * setData(data.normalize())
5265 * </pre>
5266 *
5267 * @param data The Uri of the data this intent is now targeting.
5268 *
5269 * @return Returns the same Intent object, for chaining multiple calls
5270 * into a single statement.
5271 *
5272 * @see #getData
5273 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005274 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005275 */
5276 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005277 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005278 }
5279
5280 /**
5281 * Set an explicit MIME data type.
5282 *
5283 * <p>This is used to create intents that only specify a type and not data,
5284 * for example to indicate the type of data to return.
5285 *
5286 * <p>This method automatically clears any data that was
5287 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005288 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005289 * <p><em>Note: MIME type matching in the Android framework is
5290 * case-sensitive, unlike formal RFC MIME types. As a result,
5291 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005292 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5293 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005294 *
5295 * @param type The MIME type of the data being handled by this intent.
5296 *
5297 * @return Returns the same Intent object, for chaining multiple calls
5298 * into a single statement.
5299 *
5300 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005301 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005302 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005303 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005304 */
5305 public Intent setType(String type) {
5306 mData = null;
5307 mType = type;
5308 return this;
5309 }
5310
5311 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005312 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005313 *
Nick Pellyccae4122012-01-09 14:12:58 -08005314 * <p>This is used to create intents that only specify a type and not data,
5315 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005316 *
Nick Pellyccae4122012-01-09 14:12:58 -08005317 * <p>This method automatically clears any data that was
5318 * previously set (for example by {@link #setData}).
5319 *
5320 * <p>The MIME type is normalized using
5321 * {@link #normalizeMimeType} before it is set,
5322 * so really this is just a convenience method for
5323 * <pre>
5324 * setType(Intent.normalizeMimeType(type))
5325 * </pre>
5326 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005327 * @param type The MIME type of the data being handled by this intent.
5328 *
5329 * @return Returns the same Intent object, for chaining multiple calls
5330 * into a single statement.
5331 *
Nick Pellyccae4122012-01-09 14:12:58 -08005332 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005333 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005334 * @see #normalizeMimeType
5335 */
5336 public Intent setTypeAndNormalize(String type) {
5337 return setType(normalizeMimeType(type));
5338 }
5339
5340 /**
5341 * (Usually optional) Set the data for the intent along with an explicit
5342 * MIME data type. This method should very rarely be used -- it allows you
5343 * to override the MIME type that would ordinarily be inferred from the
5344 * data with your own type given here.
5345 *
5346 * <p><em>Note: MIME type and Uri scheme matching in the
5347 * Android framework is case-sensitive, unlike the formal RFC definitions.
5348 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005349 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005350 * {@link #setDataAndTypeAndNormalize}
5351 * to ensure that they are converted to lower case.</em>
5352 *
5353 * @param data The Uri of the data this intent is now targeting.
5354 * @param type The MIME type of the data being handled by this intent.
5355 *
5356 * @return Returns the same Intent object, for chaining multiple calls
5357 * into a single statement.
5358 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005359 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005360 * @see #setData
5361 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005362 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005363 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005364 */
5365 public Intent setDataAndType(Uri data, String type) {
5366 mData = data;
5367 mType = type;
5368 return this;
5369 }
5370
5371 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005372 * (Usually optional) Normalize and set both the data Uri and an explicit
5373 * MIME data type. This method should very rarely be used -- it allows you
5374 * to override the MIME type that would ordinarily be inferred from the
5375 * data with your own type given here.
5376 *
5377 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005378 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005379 * before they are set, so really this is just a convenience method for
5380 * <pre>
5381 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5382 * </pre>
5383 *
5384 * @param data The Uri of the data this intent is now targeting.
5385 * @param type The MIME type of the data being handled by this intent.
5386 *
5387 * @return Returns the same Intent object, for chaining multiple calls
5388 * into a single statement.
5389 *
5390 * @see #setType
5391 * @see #setData
5392 * @see #setDataAndType
5393 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005394 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005395 */
5396 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005397 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005398 }
5399
5400 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005401 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005402 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005403 * activities that provide <em>all</em> of the requested categories will be
5404 * used.
5405 *
5406 * @param category The desired category. This can be either one of the
5407 * predefined Intent categories, or a custom category in your own
5408 * namespace.
5409 *
5410 * @return Returns the same Intent object, for chaining multiple calls
5411 * into a single statement.
5412 *
5413 * @see #hasCategory
5414 * @see #removeCategory
5415 */
5416 public Intent addCategory(String category) {
5417 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005418 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005419 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005420 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005421 return this;
5422 }
5423
5424 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005425 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005426 *
5427 * @param category The category to remove.
5428 *
5429 * @see #addCategory
5430 */
5431 public void removeCategory(String category) {
5432 if (mCategories != null) {
5433 mCategories.remove(category);
5434 if (mCategories.size() == 0) {
5435 mCategories = null;
5436 }
5437 }
5438 }
5439
5440 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005441 * Set a selector for this Intent. This is a modification to the kinds of
5442 * things the Intent will match. If the selector is set, it will be used
5443 * when trying to find entities that can handle the Intent, instead of the
5444 * main contents of the Intent. This allows you build an Intent containing
5445 * a generic protocol while targeting it more specifically.
5446 *
5447 * <p>An example of where this may be used is with things like
5448 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5449 * Intent that will launch the Browser application. However, the correct
5450 * main entry point of an application is actually {@link #ACTION_MAIN}
5451 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5452 * used to specify the actual Activity to launch. If you launch the browser
5453 * with something different, undesired behavior may happen if the user has
5454 * previously or later launches it the normal way, since they do not match.
5455 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5456 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5457 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5458 *
5459 * <p>Setting a selector does not impact the behavior of
5460 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5461 * desired behavior of a selector -- it does not impact the base meaning
5462 * of the Intent, just what kinds of things will be matched against it
5463 * when determining who can handle it.</p>
5464 *
5465 * <p>You can not use both a selector and {@link #setPackage(String)} on
5466 * the same base Intent.</p>
5467 *
5468 * @param selector The desired selector Intent; set to null to not use
5469 * a special selector.
5470 */
5471 public void setSelector(Intent selector) {
5472 if (selector == this) {
5473 throw new IllegalArgumentException(
5474 "Intent being set as a selector of itself");
5475 }
5476 if (selector != null && mPackage != null) {
5477 throw new IllegalArgumentException(
5478 "Can't set selector when package name is already set");
5479 }
5480 mSelector = selector;
5481 }
5482
5483 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005484 * Set a {@link ClipData} associated with this Intent. This replaces any
5485 * previously set ClipData.
5486 *
5487 * <p>The ClipData in an intent is not used for Intent matching or other
5488 * such operations. Semantically it is like extras, used to transmit
5489 * additional data with the Intent. The main feature of using this over
5490 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5491 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5492 * items included in the clip data. This is useful, in particular, if
5493 * you want to transmit an Intent containing multiple <code>content:</code>
5494 * URIs for which the recipient may not have global permission to access the
5495 * content provider.
5496 *
5497 * <p>If the ClipData contains items that are themselves Intents, any
5498 * grant flags in those Intents will be ignored. Only the top-level flags
5499 * of the main Intent are respected, and will be applied to all Uri or
5500 * Intent items in the clip (or sub-items of the clip).
5501 *
5502 * <p>The MIME type, label, and icon in the ClipData object are not
5503 * directly used by Intent. Applications should generally rely on the
5504 * MIME type of the Intent itself, not what it may find in the ClipData.
5505 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005506 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005507 *
5508 * @param clip The new clip to set. May be null to clear the current clip.
5509 */
5510 public void setClipData(ClipData clip) {
5511 mClipData = clip;
5512 }
5513
5514 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005515 * Add extended data to the intent. The name must include a package
5516 * prefix, for example the app com.android.contacts would use names
5517 * like "com.android.contacts.ShowAll".
5518 *
5519 * @param name The name of the extra data, with package prefix.
5520 * @param value The boolean data value.
5521 *
5522 * @return Returns the same Intent object, for chaining multiple calls
5523 * into a single statement.
5524 *
5525 * @see #putExtras
5526 * @see #removeExtra
5527 * @see #getBooleanExtra(String, boolean)
5528 */
5529 public Intent putExtra(String name, boolean value) {
5530 if (mExtras == null) {
5531 mExtras = new Bundle();
5532 }
5533 mExtras.putBoolean(name, value);
5534 return this;
5535 }
5536
5537 /**
5538 * Add extended data to the intent. The name must include a package
5539 * prefix, for example the app com.android.contacts would use names
5540 * like "com.android.contacts.ShowAll".
5541 *
5542 * @param name The name of the extra data, with package prefix.
5543 * @param value The byte data value.
5544 *
5545 * @return Returns the same Intent object, for chaining multiple calls
5546 * into a single statement.
5547 *
5548 * @see #putExtras
5549 * @see #removeExtra
5550 * @see #getByteExtra(String, byte)
5551 */
5552 public Intent putExtra(String name, byte value) {
5553 if (mExtras == null) {
5554 mExtras = new Bundle();
5555 }
5556 mExtras.putByte(name, value);
5557 return this;
5558 }
5559
5560 /**
5561 * Add extended data to the intent. The name must include a package
5562 * prefix, for example the app com.android.contacts would use names
5563 * like "com.android.contacts.ShowAll".
5564 *
5565 * @param name The name of the extra data, with package prefix.
5566 * @param value The char data value.
5567 *
5568 * @return Returns the same Intent object, for chaining multiple calls
5569 * into a single statement.
5570 *
5571 * @see #putExtras
5572 * @see #removeExtra
5573 * @see #getCharExtra(String, char)
5574 */
5575 public Intent putExtra(String name, char value) {
5576 if (mExtras == null) {
5577 mExtras = new Bundle();
5578 }
5579 mExtras.putChar(name, value);
5580 return this;
5581 }
5582
5583 /**
5584 * Add extended data to the intent. The name must include a package
5585 * prefix, for example the app com.android.contacts would use names
5586 * like "com.android.contacts.ShowAll".
5587 *
5588 * @param name The name of the extra data, with package prefix.
5589 * @param value The short data value.
5590 *
5591 * @return Returns the same Intent object, for chaining multiple calls
5592 * into a single statement.
5593 *
5594 * @see #putExtras
5595 * @see #removeExtra
5596 * @see #getShortExtra(String, short)
5597 */
5598 public Intent putExtra(String name, short value) {
5599 if (mExtras == null) {
5600 mExtras = new Bundle();
5601 }
5602 mExtras.putShort(name, value);
5603 return this;
5604 }
5605
5606 /**
5607 * Add extended data to the intent. The name must include a package
5608 * prefix, for example the app com.android.contacts would use names
5609 * like "com.android.contacts.ShowAll".
5610 *
5611 * @param name The name of the extra data, with package prefix.
5612 * @param value The integer data value.
5613 *
5614 * @return Returns the same Intent object, for chaining multiple calls
5615 * into a single statement.
5616 *
5617 * @see #putExtras
5618 * @see #removeExtra
5619 * @see #getIntExtra(String, int)
5620 */
5621 public Intent putExtra(String name, int value) {
5622 if (mExtras == null) {
5623 mExtras = new Bundle();
5624 }
5625 mExtras.putInt(name, value);
5626 return this;
5627 }
5628
5629 /**
5630 * Add extended data to the intent. The name must include a package
5631 * prefix, for example the app com.android.contacts would use names
5632 * like "com.android.contacts.ShowAll".
5633 *
5634 * @param name The name of the extra data, with package prefix.
5635 * @param value The long data value.
5636 *
5637 * @return Returns the same Intent object, for chaining multiple calls
5638 * into a single statement.
5639 *
5640 * @see #putExtras
5641 * @see #removeExtra
5642 * @see #getLongExtra(String, long)
5643 */
5644 public Intent putExtra(String name, long value) {
5645 if (mExtras == null) {
5646 mExtras = new Bundle();
5647 }
5648 mExtras.putLong(name, value);
5649 return this;
5650 }
5651
5652 /**
5653 * Add extended data to the intent. The name must include a package
5654 * prefix, for example the app com.android.contacts would use names
5655 * like "com.android.contacts.ShowAll".
5656 *
5657 * @param name The name of the extra data, with package prefix.
5658 * @param value The float data value.
5659 *
5660 * @return Returns the same Intent object, for chaining multiple calls
5661 * into a single statement.
5662 *
5663 * @see #putExtras
5664 * @see #removeExtra
5665 * @see #getFloatExtra(String, float)
5666 */
5667 public Intent putExtra(String name, float value) {
5668 if (mExtras == null) {
5669 mExtras = new Bundle();
5670 }
5671 mExtras.putFloat(name, value);
5672 return this;
5673 }
5674
5675 /**
5676 * Add extended data to the intent. The name must include a package
5677 * prefix, for example the app com.android.contacts would use names
5678 * like "com.android.contacts.ShowAll".
5679 *
5680 * @param name The name of the extra data, with package prefix.
5681 * @param value The double data value.
5682 *
5683 * @return Returns the same Intent object, for chaining multiple calls
5684 * into a single statement.
5685 *
5686 * @see #putExtras
5687 * @see #removeExtra
5688 * @see #getDoubleExtra(String, double)
5689 */
5690 public Intent putExtra(String name, double value) {
5691 if (mExtras == null) {
5692 mExtras = new Bundle();
5693 }
5694 mExtras.putDouble(name, value);
5695 return this;
5696 }
5697
5698 /**
5699 * Add extended data to the intent. The name must include a package
5700 * prefix, for example the app com.android.contacts would use names
5701 * like "com.android.contacts.ShowAll".
5702 *
5703 * @param name The name of the extra data, with package prefix.
5704 * @param value The String data value.
5705 *
5706 * @return Returns the same Intent object, for chaining multiple calls
5707 * into a single statement.
5708 *
5709 * @see #putExtras
5710 * @see #removeExtra
5711 * @see #getStringExtra(String)
5712 */
5713 public Intent putExtra(String name, String value) {
5714 if (mExtras == null) {
5715 mExtras = new Bundle();
5716 }
5717 mExtras.putString(name, value);
5718 return this;
5719 }
5720
5721 /**
5722 * Add extended data to the intent. The name must include a package
5723 * prefix, for example the app com.android.contacts would use names
5724 * like "com.android.contacts.ShowAll".
5725 *
5726 * @param name The name of the extra data, with package prefix.
5727 * @param value The CharSequence data value.
5728 *
5729 * @return Returns the same Intent object, for chaining multiple calls
5730 * into a single statement.
5731 *
5732 * @see #putExtras
5733 * @see #removeExtra
5734 * @see #getCharSequenceExtra(String)
5735 */
5736 public Intent putExtra(String name, CharSequence value) {
5737 if (mExtras == null) {
5738 mExtras = new Bundle();
5739 }
5740 mExtras.putCharSequence(name, value);
5741 return this;
5742 }
5743
5744 /**
5745 * Add extended data to the intent. The name must include a package
5746 * prefix, for example the app com.android.contacts would use names
5747 * like "com.android.contacts.ShowAll".
5748 *
5749 * @param name The name of the extra data, with package prefix.
5750 * @param value The Parcelable data value.
5751 *
5752 * @return Returns the same Intent object, for chaining multiple calls
5753 * into a single statement.
5754 *
5755 * @see #putExtras
5756 * @see #removeExtra
5757 * @see #getParcelableExtra(String)
5758 */
5759 public Intent putExtra(String name, Parcelable value) {
5760 if (mExtras == null) {
5761 mExtras = new Bundle();
5762 }
5763 mExtras.putParcelable(name, value);
5764 return this;
5765 }
5766
5767 /**
5768 * Add extended data to the intent. The name must include a package
5769 * prefix, for example the app com.android.contacts would use names
5770 * like "com.android.contacts.ShowAll".
5771 *
5772 * @param name The name of the extra data, with package prefix.
5773 * @param value The Parcelable[] data value.
5774 *
5775 * @return Returns the same Intent object, for chaining multiple calls
5776 * into a single statement.
5777 *
5778 * @see #putExtras
5779 * @see #removeExtra
5780 * @see #getParcelableArrayExtra(String)
5781 */
5782 public Intent putExtra(String name, Parcelable[] value) {
5783 if (mExtras == null) {
5784 mExtras = new Bundle();
5785 }
5786 mExtras.putParcelableArray(name, value);
5787 return this;
5788 }
5789
5790 /**
5791 * Add extended data to the intent. The name must include a package
5792 * prefix, for example the app com.android.contacts would use names
5793 * like "com.android.contacts.ShowAll".
5794 *
5795 * @param name The name of the extra data, with package prefix.
5796 * @param value The ArrayList<Parcelable> data value.
5797 *
5798 * @return Returns the same Intent object, for chaining multiple calls
5799 * into a single statement.
5800 *
5801 * @see #putExtras
5802 * @see #removeExtra
5803 * @see #getParcelableArrayListExtra(String)
5804 */
5805 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5806 if (mExtras == null) {
5807 mExtras = new Bundle();
5808 }
5809 mExtras.putParcelableArrayList(name, value);
5810 return this;
5811 }
5812
5813 /**
5814 * Add extended data to the intent. The name must include a package
5815 * prefix, for example the app com.android.contacts would use names
5816 * like "com.android.contacts.ShowAll".
5817 *
5818 * @param name The name of the extra data, with package prefix.
5819 * @param value The ArrayList<Integer> data value.
5820 *
5821 * @return Returns the same Intent object, for chaining multiple calls
5822 * into a single statement.
5823 *
5824 * @see #putExtras
5825 * @see #removeExtra
5826 * @see #getIntegerArrayListExtra(String)
5827 */
5828 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5829 if (mExtras == null) {
5830 mExtras = new Bundle();
5831 }
5832 mExtras.putIntegerArrayList(name, value);
5833 return this;
5834 }
5835
5836 /**
5837 * Add extended data to the intent. The name must include a package
5838 * prefix, for example the app com.android.contacts would use names
5839 * like "com.android.contacts.ShowAll".
5840 *
5841 * @param name The name of the extra data, with package prefix.
5842 * @param value The ArrayList<String> data value.
5843 *
5844 * @return Returns the same Intent object, for chaining multiple calls
5845 * into a single statement.
5846 *
5847 * @see #putExtras
5848 * @see #removeExtra
5849 * @see #getStringArrayListExtra(String)
5850 */
5851 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5852 if (mExtras == null) {
5853 mExtras = new Bundle();
5854 }
5855 mExtras.putStringArrayList(name, value);
5856 return this;
5857 }
5858
5859 /**
5860 * Add extended data to the intent. The name must include a package
5861 * prefix, for example the app com.android.contacts would use names
5862 * like "com.android.contacts.ShowAll".
5863 *
5864 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005865 * @param value The ArrayList<CharSequence> data value.
5866 *
5867 * @return Returns the same Intent object, for chaining multiple calls
5868 * into a single statement.
5869 *
5870 * @see #putExtras
5871 * @see #removeExtra
5872 * @see #getCharSequenceArrayListExtra(String)
5873 */
5874 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5875 if (mExtras == null) {
5876 mExtras = new Bundle();
5877 }
5878 mExtras.putCharSequenceArrayList(name, value);
5879 return this;
5880 }
5881
5882 /**
5883 * Add extended data to the intent. The name must include a package
5884 * prefix, for example the app com.android.contacts would use names
5885 * like "com.android.contacts.ShowAll".
5886 *
5887 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005888 * @param value The Serializable data value.
5889 *
5890 * @return Returns the same Intent object, for chaining multiple calls
5891 * into a single statement.
5892 *
5893 * @see #putExtras
5894 * @see #removeExtra
5895 * @see #getSerializableExtra(String)
5896 */
5897 public Intent putExtra(String name, Serializable value) {
5898 if (mExtras == null) {
5899 mExtras = new Bundle();
5900 }
5901 mExtras.putSerializable(name, value);
5902 return this;
5903 }
5904
5905 /**
5906 * Add extended data to the intent. The name must include a package
5907 * prefix, for example the app com.android.contacts would use names
5908 * like "com.android.contacts.ShowAll".
5909 *
5910 * @param name The name of the extra data, with package prefix.
5911 * @param value The boolean array data value.
5912 *
5913 * @return Returns the same Intent object, for chaining multiple calls
5914 * into a single statement.
5915 *
5916 * @see #putExtras
5917 * @see #removeExtra
5918 * @see #getBooleanArrayExtra(String)
5919 */
5920 public Intent putExtra(String name, boolean[] value) {
5921 if (mExtras == null) {
5922 mExtras = new Bundle();
5923 }
5924 mExtras.putBooleanArray(name, value);
5925 return this;
5926 }
5927
5928 /**
5929 * Add extended data to the intent. The name must include a package
5930 * prefix, for example the app com.android.contacts would use names
5931 * like "com.android.contacts.ShowAll".
5932 *
5933 * @param name The name of the extra data, with package prefix.
5934 * @param value The byte array data value.
5935 *
5936 * @return Returns the same Intent object, for chaining multiple calls
5937 * into a single statement.
5938 *
5939 * @see #putExtras
5940 * @see #removeExtra
5941 * @see #getByteArrayExtra(String)
5942 */
5943 public Intent putExtra(String name, byte[] value) {
5944 if (mExtras == null) {
5945 mExtras = new Bundle();
5946 }
5947 mExtras.putByteArray(name, value);
5948 return this;
5949 }
5950
5951 /**
5952 * Add extended data to the intent. The name must include a package
5953 * prefix, for example the app com.android.contacts would use names
5954 * like "com.android.contacts.ShowAll".
5955 *
5956 * @param name The name of the extra data, with package prefix.
5957 * @param value The short array data value.
5958 *
5959 * @return Returns the same Intent object, for chaining multiple calls
5960 * into a single statement.
5961 *
5962 * @see #putExtras
5963 * @see #removeExtra
5964 * @see #getShortArrayExtra(String)
5965 */
5966 public Intent putExtra(String name, short[] value) {
5967 if (mExtras == null) {
5968 mExtras = new Bundle();
5969 }
5970 mExtras.putShortArray(name, value);
5971 return this;
5972 }
5973
5974 /**
5975 * Add extended data to the intent. The name must include a package
5976 * prefix, for example the app com.android.contacts would use names
5977 * like "com.android.contacts.ShowAll".
5978 *
5979 * @param name The name of the extra data, with package prefix.
5980 * @param value The char array data value.
5981 *
5982 * @return Returns the same Intent object, for chaining multiple calls
5983 * into a single statement.
5984 *
5985 * @see #putExtras
5986 * @see #removeExtra
5987 * @see #getCharArrayExtra(String)
5988 */
5989 public Intent putExtra(String name, char[] value) {
5990 if (mExtras == null) {
5991 mExtras = new Bundle();
5992 }
5993 mExtras.putCharArray(name, value);
5994 return this;
5995 }
5996
5997 /**
5998 * Add extended data to the intent. The name must include a package
5999 * prefix, for example the app com.android.contacts would use names
6000 * like "com.android.contacts.ShowAll".
6001 *
6002 * @param name The name of the extra data, with package prefix.
6003 * @param value The int array data value.
6004 *
6005 * @return Returns the same Intent object, for chaining multiple calls
6006 * into a single statement.
6007 *
6008 * @see #putExtras
6009 * @see #removeExtra
6010 * @see #getIntArrayExtra(String)
6011 */
6012 public Intent putExtra(String name, int[] value) {
6013 if (mExtras == null) {
6014 mExtras = new Bundle();
6015 }
6016 mExtras.putIntArray(name, value);
6017 return this;
6018 }
6019
6020 /**
6021 * Add extended data to the intent. The name must include a package
6022 * prefix, for example the app com.android.contacts would use names
6023 * like "com.android.contacts.ShowAll".
6024 *
6025 * @param name The name of the extra data, with package prefix.
6026 * @param value The byte array data value.
6027 *
6028 * @return Returns the same Intent object, for chaining multiple calls
6029 * into a single statement.
6030 *
6031 * @see #putExtras
6032 * @see #removeExtra
6033 * @see #getLongArrayExtra(String)
6034 */
6035 public Intent putExtra(String name, long[] value) {
6036 if (mExtras == null) {
6037 mExtras = new Bundle();
6038 }
6039 mExtras.putLongArray(name, value);
6040 return this;
6041 }
6042
6043 /**
6044 * Add extended data to the intent. The name must include a package
6045 * prefix, for example the app com.android.contacts would use names
6046 * like "com.android.contacts.ShowAll".
6047 *
6048 * @param name The name of the extra data, with package prefix.
6049 * @param value The float array data value.
6050 *
6051 * @return Returns the same Intent object, for chaining multiple calls
6052 * into a single statement.
6053 *
6054 * @see #putExtras
6055 * @see #removeExtra
6056 * @see #getFloatArrayExtra(String)
6057 */
6058 public Intent putExtra(String name, float[] value) {
6059 if (mExtras == null) {
6060 mExtras = new Bundle();
6061 }
6062 mExtras.putFloatArray(name, value);
6063 return this;
6064 }
6065
6066 /**
6067 * Add extended data to the intent. The name must include a package
6068 * prefix, for example the app com.android.contacts would use names
6069 * like "com.android.contacts.ShowAll".
6070 *
6071 * @param name The name of the extra data, with package prefix.
6072 * @param value The double array data value.
6073 *
6074 * @return Returns the same Intent object, for chaining multiple calls
6075 * into a single statement.
6076 *
6077 * @see #putExtras
6078 * @see #removeExtra
6079 * @see #getDoubleArrayExtra(String)
6080 */
6081 public Intent putExtra(String name, double[] value) {
6082 if (mExtras == null) {
6083 mExtras = new Bundle();
6084 }
6085 mExtras.putDoubleArray(name, value);
6086 return this;
6087 }
6088
6089 /**
6090 * Add extended data to the intent. The name must include a package
6091 * prefix, for example the app com.android.contacts would use names
6092 * like "com.android.contacts.ShowAll".
6093 *
6094 * @param name The name of the extra data, with package prefix.
6095 * @param value The String array data value.
6096 *
6097 * @return Returns the same Intent object, for chaining multiple calls
6098 * into a single statement.
6099 *
6100 * @see #putExtras
6101 * @see #removeExtra
6102 * @see #getStringArrayExtra(String)
6103 */
6104 public Intent putExtra(String name, String[] value) {
6105 if (mExtras == null) {
6106 mExtras = new Bundle();
6107 }
6108 mExtras.putStringArray(name, value);
6109 return this;
6110 }
6111
6112 /**
6113 * Add extended data to the intent. The name must include a package
6114 * prefix, for example the app com.android.contacts would use names
6115 * like "com.android.contacts.ShowAll".
6116 *
6117 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006118 * @param value The CharSequence array data value.
6119 *
6120 * @return Returns the same Intent object, for chaining multiple calls
6121 * into a single statement.
6122 *
6123 * @see #putExtras
6124 * @see #removeExtra
6125 * @see #getCharSequenceArrayExtra(String)
6126 */
6127 public Intent putExtra(String name, CharSequence[] value) {
6128 if (mExtras == null) {
6129 mExtras = new Bundle();
6130 }
6131 mExtras.putCharSequenceArray(name, value);
6132 return this;
6133 }
6134
6135 /**
6136 * Add extended data to the intent. The name must include a package
6137 * prefix, for example the app com.android.contacts would use names
6138 * like "com.android.contacts.ShowAll".
6139 *
6140 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006141 * @param value The Bundle data value.
6142 *
6143 * @return Returns the same Intent object, for chaining multiple calls
6144 * into a single statement.
6145 *
6146 * @see #putExtras
6147 * @see #removeExtra
6148 * @see #getBundleExtra(String)
6149 */
6150 public Intent putExtra(String name, Bundle value) {
6151 if (mExtras == null) {
6152 mExtras = new Bundle();
6153 }
6154 mExtras.putBundle(name, value);
6155 return this;
6156 }
6157
6158 /**
6159 * Add extended data to the intent. The name must include a package
6160 * prefix, for example the app com.android.contacts would use names
6161 * like "com.android.contacts.ShowAll".
6162 *
6163 * @param name The name of the extra data, with package prefix.
6164 * @param value The IBinder data value.
6165 *
6166 * @return Returns the same Intent object, for chaining multiple calls
6167 * into a single statement.
6168 *
6169 * @see #putExtras
6170 * @see #removeExtra
6171 * @see #getIBinderExtra(String)
6172 *
6173 * @deprecated
6174 * @hide
6175 */
6176 @Deprecated
6177 public Intent putExtra(String name, IBinder value) {
6178 if (mExtras == null) {
6179 mExtras = new Bundle();
6180 }
6181 mExtras.putIBinder(name, value);
6182 return this;
6183 }
6184
6185 /**
6186 * Copy all extras in 'src' in to this intent.
6187 *
6188 * @param src Contains the extras to copy.
6189 *
6190 * @see #putExtra
6191 */
6192 public Intent putExtras(Intent src) {
6193 if (src.mExtras != null) {
6194 if (mExtras == null) {
6195 mExtras = new Bundle(src.mExtras);
6196 } else {
6197 mExtras.putAll(src.mExtras);
6198 }
6199 }
6200 return this;
6201 }
6202
6203 /**
6204 * Add a set of extended data to the intent. The keys must include a package
6205 * prefix, for example the app com.android.contacts would use names
6206 * like "com.android.contacts.ShowAll".
6207 *
6208 * @param extras The Bundle of extras to add to this intent.
6209 *
6210 * @see #putExtra
6211 * @see #removeExtra
6212 */
6213 public Intent putExtras(Bundle extras) {
6214 if (mExtras == null) {
6215 mExtras = new Bundle();
6216 }
6217 mExtras.putAll(extras);
6218 return this;
6219 }
6220
6221 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006222 * Completely replace the extras in the Intent with the extras in the
6223 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006224 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006225 * @param src The exact extras contained in this Intent are copied
6226 * into the target intent, replacing any that were previously there.
6227 */
6228 public Intent replaceExtras(Intent src) {
6229 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6230 return this;
6231 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006232
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006233 /**
6234 * Completely replace the extras in the Intent with the given Bundle of
6235 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006236 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006237 * @param extras The new set of extras in the Intent, or null to erase
6238 * all extras.
6239 */
6240 public Intent replaceExtras(Bundle extras) {
6241 mExtras = extras != null ? new Bundle(extras) : null;
6242 return this;
6243 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006244
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006245 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006246 * Remove extended data from the intent.
6247 *
6248 * @see #putExtra
6249 */
6250 public void removeExtra(String name) {
6251 if (mExtras != null) {
6252 mExtras.remove(name);
6253 if (mExtras.size() == 0) {
6254 mExtras = null;
6255 }
6256 }
6257 }
6258
6259 /**
6260 * Set special flags controlling how this intent is handled. Most values
6261 * here depend on the type of component being executed by the Intent,
6262 * specifically the FLAG_ACTIVITY_* flags are all for use with
6263 * {@link Context#startActivity Context.startActivity()} and the
6264 * FLAG_RECEIVER_* flags are all for use with
6265 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6266 *
Scott Main7aee61f2011-02-08 11:25:01 -08006267 * <p>See the
6268 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6269 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006270 * the behavior of your application.
6271 *
6272 * @param flags The desired flags.
6273 *
6274 * @return Returns the same Intent object, for chaining multiple calls
6275 * into a single statement.
6276 *
6277 * @see #getFlags
6278 * @see #addFlags
6279 *
6280 * @see #FLAG_GRANT_READ_URI_PERMISSION
6281 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6282 * @see #FLAG_DEBUG_LOG_RESOLUTION
6283 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006284 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006285 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006286 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006287 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006288 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6289 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006290 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006291 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006292 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006293 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006294 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006295 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006296 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006297 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6298 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006299 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006300 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006301 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006302 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6303 */
6304 public Intent setFlags(int flags) {
6305 mFlags = flags;
6306 return this;
6307 }
6308
6309 /**
6310 * Add additional flags to the intent (or with existing flags
6311 * value).
6312 *
6313 * @param flags The new flags to set.
6314 *
6315 * @return Returns the same Intent object, for chaining multiple calls
6316 * into a single statement.
6317 *
6318 * @see #setFlags
6319 */
6320 public Intent addFlags(int flags) {
6321 mFlags |= flags;
6322 return this;
6323 }
6324
6325 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006326 * (Usually optional) Set an explicit application package name that limits
6327 * the components this Intent will resolve to. If left to the default
6328 * value of null, all components in all applications will considered.
6329 * If non-null, the Intent can only match the components in the given
6330 * application package.
6331 *
6332 * @param packageName The name of the application package to handle the
6333 * intent, or null to allow any application package.
6334 *
6335 * @return Returns the same Intent object, for chaining multiple calls
6336 * into a single statement.
6337 *
6338 * @see #getPackage
6339 * @see #resolveActivity
6340 */
6341 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006342 if (packageName != null && mSelector != null) {
6343 throw new IllegalArgumentException(
6344 "Can't set package name when selector is already set");
6345 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006346 mPackage = packageName;
6347 return this;
6348 }
6349
6350 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006351 * (Usually optional) Explicitly set the component to handle the intent.
6352 * If left with the default value of null, the system will determine the
6353 * appropriate class to use based on the other fields (action, data,
6354 * type, categories) in the Intent. If this class is defined, the
6355 * specified class will always be used regardless of the other fields. You
6356 * should only set this value when you know you absolutely want a specific
6357 * class to be used; otherwise it is better to let the system find the
6358 * appropriate class so that you will respect the installed applications
6359 * and user preferences.
6360 *
6361 * @param component The name of the application component to handle the
6362 * intent, or null to let the system find one for you.
6363 *
6364 * @return Returns the same Intent object, for chaining multiple calls
6365 * into a single statement.
6366 *
6367 * @see #setClass
6368 * @see #setClassName(Context, String)
6369 * @see #setClassName(String, String)
6370 * @see #getComponent
6371 * @see #resolveActivity
6372 */
6373 public Intent setComponent(ComponentName component) {
6374 mComponent = component;
6375 return this;
6376 }
6377
6378 /**
6379 * Convenience for calling {@link #setComponent} with an
6380 * explicit class name.
6381 *
6382 * @param packageContext A Context of the application package implementing
6383 * this class.
6384 * @param className The name of a class inside of the application package
6385 * that will be used as the component for this Intent.
6386 *
6387 * @return Returns the same Intent object, for chaining multiple calls
6388 * into a single statement.
6389 *
6390 * @see #setComponent
6391 * @see #setClass
6392 */
6393 public Intent setClassName(Context packageContext, String className) {
6394 mComponent = new ComponentName(packageContext, className);
6395 return this;
6396 }
6397
6398 /**
6399 * Convenience for calling {@link #setComponent} with an
6400 * explicit application package name and class name.
6401 *
6402 * @param packageName The name of the package implementing the desired
6403 * component.
6404 * @param className The name of a class inside of the application package
6405 * that will be used as the component for this Intent.
6406 *
6407 * @return Returns the same Intent object, for chaining multiple calls
6408 * into a single statement.
6409 *
6410 * @see #setComponent
6411 * @see #setClass
6412 */
6413 public Intent setClassName(String packageName, String className) {
6414 mComponent = new ComponentName(packageName, className);
6415 return this;
6416 }
6417
6418 /**
6419 * Convenience for calling {@link #setComponent(ComponentName)} with the
6420 * name returned by a {@link Class} object.
6421 *
6422 * @param packageContext A Context of the application package implementing
6423 * this class.
6424 * @param cls The class name to set, equivalent to
6425 * <code>setClassName(context, cls.getName())</code>.
6426 *
6427 * @return Returns the same Intent object, for chaining multiple calls
6428 * into a single statement.
6429 *
6430 * @see #setComponent
6431 */
6432 public Intent setClass(Context packageContext, Class<?> cls) {
6433 mComponent = new ComponentName(packageContext, cls);
6434 return this;
6435 }
6436
6437 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006438 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6439 * used as a hint to the receiver for animations and the like. Null means that there
6440 * is no source bounds.
6441 */
6442 public void setSourceBounds(Rect r) {
6443 if (r != null) {
6444 mSourceBounds = new Rect(r);
6445 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006446 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006447 }
6448 }
6449
Tor Norbyed9273d62013-05-30 15:59:53 -07006450 /** @hide */
6451 @IntDef(flag = true,
6452 value = {
6453 FILL_IN_ACTION,
6454 FILL_IN_DATA,
6455 FILL_IN_CATEGORIES,
6456 FILL_IN_COMPONENT,
6457 FILL_IN_PACKAGE,
6458 FILL_IN_SOURCE_BOUNDS,
6459 FILL_IN_SELECTOR,
6460 FILL_IN_CLIP_DATA
6461 })
6462 @Retention(RetentionPolicy.SOURCE)
6463 public @interface FillInFlags {}
6464
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006465 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006466 * Use with {@link #fillIn} to allow the current action value to be
6467 * overwritten, even if it is already set.
6468 */
6469 public static final int FILL_IN_ACTION = 1<<0;
6470
6471 /**
6472 * Use with {@link #fillIn} to allow the current data or type value
6473 * overwritten, even if it is already set.
6474 */
6475 public static final int FILL_IN_DATA = 1<<1;
6476
6477 /**
6478 * Use with {@link #fillIn} to allow the current categories to be
6479 * overwritten, even if they are already set.
6480 */
6481 public static final int FILL_IN_CATEGORIES = 1<<2;
6482
6483 /**
6484 * Use with {@link #fillIn} to allow the current component value to be
6485 * overwritten, even if it is already set.
6486 */
6487 public static final int FILL_IN_COMPONENT = 1<<3;
6488
6489 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006490 * Use with {@link #fillIn} to allow the current package value to be
6491 * overwritten, even if it is already set.
6492 */
6493 public static final int FILL_IN_PACKAGE = 1<<4;
6494
6495 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006496 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006497 * overwritten, even if it is already set.
6498 */
6499 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6500
6501 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006502 * Use with {@link #fillIn} to allow the current selector to be
6503 * overwritten, even if it is already set.
6504 */
6505 public static final int FILL_IN_SELECTOR = 1<<6;
6506
6507 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006508 * Use with {@link #fillIn} to allow the current ClipData to be
6509 * overwritten, even if it is already set.
6510 */
6511 public static final int FILL_IN_CLIP_DATA = 1<<7;
6512
6513 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006514 * Copy the contents of <var>other</var> in to this object, but only
6515 * where fields are not defined by this object. For purposes of a field
6516 * being defined, the following pieces of data in the Intent are
6517 * considered to be separate fields:
6518 *
6519 * <ul>
6520 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006521 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006522 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6523 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006524 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006525 * <li> component, as set by {@link #setComponent(ComponentName)} or
6526 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006527 * <li> source bounds, as set by {@link #setSourceBounds}.
6528 * <li> selector, as set by {@link #setSelector(Intent)}.
6529 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006530 * <li> each top-level name in the associated extras.
6531 * </ul>
6532 *
6533 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006534 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006535 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6536 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6537 * the restriction where the corresponding field will not be replaced if
6538 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006539 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006540 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6541 * is explicitly specified. The selector will only be copied if
6542 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006543 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006544 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6545 * and Intent B with {action="gotit", data-type="some/thing",
6546 * categories="one","two"}.
6547 *
6548 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6549 * containing: {action="gotit", data-type="some/thing",
6550 * categories="bar"}.
6551 *
6552 * @param other Another Intent whose values are to be used to fill in
6553 * the current one.
6554 * @param flags Options to control which fields can be filled in.
6555 *
6556 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006557 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006558 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6559 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6560 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006561 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006562 @FillInFlags
6563 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006564 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006565 if (other.mAction != null
6566 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006567 mAction = other.mAction;
6568 changes |= FILL_IN_ACTION;
6569 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006570 if ((other.mData != null || other.mType != null)
6571 && ((mData == null && mType == null)
6572 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006573 mData = other.mData;
6574 mType = other.mType;
6575 changes |= FILL_IN_DATA;
6576 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006577 if (other.mCategories != null
6578 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006579 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006580 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006581 }
6582 changes |= FILL_IN_CATEGORIES;
6583 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006584 if (other.mPackage != null
6585 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006586 // Only do this if mSelector is not set.
6587 if (mSelector == null) {
6588 mPackage = other.mPackage;
6589 changes |= FILL_IN_PACKAGE;
6590 }
6591 }
6592 // Selector is special: it can only be set if explicitly allowed,
6593 // for the same reason as the component name.
6594 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6595 if (mPackage == null) {
6596 mSelector = new Intent(other.mSelector);
6597 mPackage = null;
6598 changes |= FILL_IN_SELECTOR;
6599 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006600 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006601 if (other.mClipData != null
6602 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6603 mClipData = other.mClipData;
6604 changes |= FILL_IN_CLIP_DATA;
6605 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006606 // Component is special: it can -only- be set if explicitly allowed,
6607 // since otherwise the sender could force the intent somewhere the
6608 // originator didn't intend.
6609 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006610 mComponent = other.mComponent;
6611 changes |= FILL_IN_COMPONENT;
6612 }
6613 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006614 if (other.mSourceBounds != null
6615 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6616 mSourceBounds = new Rect(other.mSourceBounds);
6617 changes |= FILL_IN_SOURCE_BOUNDS;
6618 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006619 if (mExtras == null) {
6620 if (other.mExtras != null) {
6621 mExtras = new Bundle(other.mExtras);
6622 }
6623 } else if (other.mExtras != null) {
6624 try {
6625 Bundle newb = new Bundle(other.mExtras);
6626 newb.putAll(mExtras);
6627 mExtras = newb;
6628 } catch (RuntimeException e) {
6629 // Modifying the extras can cause us to unparcel the contents
6630 // of the bundle, and if we do this in the system process that
6631 // may fail. We really should handle this (i.e., the Bundle
6632 // impl shouldn't be on top of a plain map), but for now just
6633 // ignore it and keep the original contents. :(
6634 Log.w("Intent", "Failure filling in extras", e);
6635 }
6636 }
6637 return changes;
6638 }
6639
6640 /**
6641 * Wrapper class holding an Intent and implementing comparisons on it for
6642 * the purpose of filtering. The class implements its
6643 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6644 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6645 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6646 * on the wrapped Intent.
6647 */
6648 public static final class FilterComparison {
6649 private final Intent mIntent;
6650 private final int mHashCode;
6651
6652 public FilterComparison(Intent intent) {
6653 mIntent = intent;
6654 mHashCode = intent.filterHashCode();
6655 }
6656
6657 /**
6658 * Return the Intent that this FilterComparison represents.
6659 * @return Returns the Intent held by the FilterComparison. Do
6660 * not modify!
6661 */
6662 public Intent getIntent() {
6663 return mIntent;
6664 }
6665
6666 @Override
6667 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006668 if (obj instanceof FilterComparison) {
6669 Intent other = ((FilterComparison)obj).mIntent;
6670 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006671 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006672 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006673 }
6674
6675 @Override
6676 public int hashCode() {
6677 return mHashCode;
6678 }
6679 }
6680
6681 /**
6682 * Determine if two intents are the same for the purposes of intent
6683 * resolution (filtering). That is, if their action, data, type,
6684 * class, and categories are the same. This does <em>not</em> compare
6685 * any extra data included in the intents.
6686 *
6687 * @param other The other Intent to compare against.
6688 *
6689 * @return Returns true if action, data, type, class, and categories
6690 * are the same.
6691 */
6692 public boolean filterEquals(Intent other) {
6693 if (other == null) {
6694 return false;
6695 }
6696 if (mAction != other.mAction) {
6697 if (mAction != null) {
6698 if (!mAction.equals(other.mAction)) {
6699 return false;
6700 }
6701 } else {
6702 if (!other.mAction.equals(mAction)) {
6703 return false;
6704 }
6705 }
6706 }
6707 if (mData != other.mData) {
6708 if (mData != null) {
6709 if (!mData.equals(other.mData)) {
6710 return false;
6711 }
6712 } else {
6713 if (!other.mData.equals(mData)) {
6714 return false;
6715 }
6716 }
6717 }
6718 if (mType != other.mType) {
6719 if (mType != null) {
6720 if (!mType.equals(other.mType)) {
6721 return false;
6722 }
6723 } else {
6724 if (!other.mType.equals(mType)) {
6725 return false;
6726 }
6727 }
6728 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006729 if (mPackage != other.mPackage) {
6730 if (mPackage != null) {
6731 if (!mPackage.equals(other.mPackage)) {
6732 return false;
6733 }
6734 } else {
6735 if (!other.mPackage.equals(mPackage)) {
6736 return false;
6737 }
6738 }
6739 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006740 if (mComponent != other.mComponent) {
6741 if (mComponent != null) {
6742 if (!mComponent.equals(other.mComponent)) {
6743 return false;
6744 }
6745 } else {
6746 if (!other.mComponent.equals(mComponent)) {
6747 return false;
6748 }
6749 }
6750 }
6751 if (mCategories != other.mCategories) {
6752 if (mCategories != null) {
6753 if (!mCategories.equals(other.mCategories)) {
6754 return false;
6755 }
6756 } else {
6757 if (!other.mCategories.equals(mCategories)) {
6758 return false;
6759 }
6760 }
6761 }
6762
6763 return true;
6764 }
6765
6766 /**
6767 * Generate hash code that matches semantics of filterEquals().
6768 *
6769 * @return Returns the hash value of the action, data, type, class, and
6770 * categories.
6771 *
6772 * @see #filterEquals
6773 */
6774 public int filterHashCode() {
6775 int code = 0;
6776 if (mAction != null) {
6777 code += mAction.hashCode();
6778 }
6779 if (mData != null) {
6780 code += mData.hashCode();
6781 }
6782 if (mType != null) {
6783 code += mType.hashCode();
6784 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006785 if (mPackage != null) {
6786 code += mPackage.hashCode();
6787 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006788 if (mComponent != null) {
6789 code += mComponent.hashCode();
6790 }
6791 if (mCategories != null) {
6792 code += mCategories.hashCode();
6793 }
6794 return code;
6795 }
6796
6797 @Override
6798 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006799 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006800
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006801 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006802 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006803 b.append(" }");
6804
6805 return b.toString();
6806 }
6807
6808 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006809 public String toInsecureString() {
6810 StringBuilder b = new StringBuilder(128);
6811
6812 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006813 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006814 b.append(" }");
6815
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006816 return b.toString();
6817 }
Romain Guy4969af72009-06-17 10:53:19 -07006818
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006819 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006820 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006821 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006822
6823 b.append("Intent { ");
6824 toShortString(b, false, true, true, true);
6825 b.append(" }");
6826
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006827 return b.toString();
6828 }
6829
6830 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006831 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6832 StringBuilder b = new StringBuilder(128);
6833 toShortString(b, secure, comp, extras, clip);
6834 return b.toString();
6835 }
6836
6837 /** @hide */
6838 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6839 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006840 boolean first = true;
6841 if (mAction != null) {
6842 b.append("act=").append(mAction);
6843 first = false;
6844 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006845 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006846 if (!first) {
6847 b.append(' ');
6848 }
6849 first = false;
6850 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006851 for (int i=0; i<mCategories.size(); i++) {
6852 if (i > 0) b.append(',');
6853 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006854 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006855 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006856 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006857 if (mData != null) {
6858 if (!first) {
6859 b.append(' ');
6860 }
6861 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006862 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006863 if (secure) {
6864 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006865 } else {
6866 b.append(mData);
6867 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006868 }
6869 if (mType != null) {
6870 if (!first) {
6871 b.append(' ');
6872 }
6873 first = false;
6874 b.append("typ=").append(mType);
6875 }
6876 if (mFlags != 0) {
6877 if (!first) {
6878 b.append(' ');
6879 }
6880 first = false;
6881 b.append("flg=0x").append(Integer.toHexString(mFlags));
6882 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006883 if (mPackage != null) {
6884 if (!first) {
6885 b.append(' ');
6886 }
6887 first = false;
6888 b.append("pkg=").append(mPackage);
6889 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006890 if (comp && mComponent != null) {
6891 if (!first) {
6892 b.append(' ');
6893 }
6894 first = false;
6895 b.append("cmp=").append(mComponent.flattenToShortString());
6896 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006897 if (mSourceBounds != null) {
6898 if (!first) {
6899 b.append(' ');
6900 }
6901 first = false;
6902 b.append("bnds=").append(mSourceBounds.toShortString());
6903 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006904 if (mClipData != null) {
6905 if (!first) {
6906 b.append(' ');
6907 }
6908 first = false;
6909 if (clip) {
6910 b.append("clip={");
6911 mClipData.toShortString(b);
6912 b.append('}');
6913 } else {
6914 b.append("(has clip)");
6915 }
6916 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006917 if (extras && mExtras != null) {
6918 if (!first) {
6919 b.append(' ');
6920 }
6921 first = false;
6922 b.append("(has extras)");
6923 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006924 if (mSelector != null) {
6925 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006926 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006927 b.append("}");
6928 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006929 }
6930
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006931 /**
6932 * Call {@link #toUri} with 0 flags.
6933 * @deprecated Use {@link #toUri} instead.
6934 */
6935 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006936 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006937 return toUri(0);
6938 }
6939
6940 /**
6941 * Convert this Intent into a String holding a URI representation of it.
6942 * The returned URI string has been properly URI encoded, so it can be
6943 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6944 * Intent's data as the base URI, with an additional fragment describing
6945 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006946 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006947 * <p>You can convert the returned string back to an Intent with
6948 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006949 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006950 * @param flags Additional operating flags. Either 0 or
6951 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006952 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006953 * @return Returns a URI encoding URI string describing the entire contents
6954 * of the Intent.
6955 */
6956 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006957 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006958 String scheme = null;
6959 if (mData != null) {
6960 String data = mData.toString();
6961 if ((flags&URI_INTENT_SCHEME) != 0) {
6962 final int N = data.length();
6963 for (int i=0; i<N; i++) {
6964 char c = data.charAt(i);
6965 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6966 || c == '.' || c == '-') {
6967 continue;
6968 }
6969 if (c == ':' && i > 0) {
6970 // Valid scheme.
6971 scheme = data.substring(0, i);
6972 uri.append("intent:");
6973 data = data.substring(i+1);
6974 break;
6975 }
Tom Taylord4a47292009-12-21 13:59:18 -08006976
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006977 // No scheme.
6978 break;
6979 }
6980 }
6981 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006982
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006983 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6984 uri.append("intent:");
6985 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006986
6987 uri.append("#Intent;");
6988
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006989 toUriInner(uri, scheme, flags);
6990 if (mSelector != null) {
6991 uri.append("SEL;");
6992 // Note that for now we are not going to try to handle the
6993 // data part; not clear how to represent this as a URI, and
6994 // not much utility in it.
6995 mSelector.toUriInner(uri, null, flags);
6996 }
6997
6998 uri.append("end");
6999
7000 return uri.toString();
7001 }
7002
7003 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007004 if (scheme != null) {
7005 uri.append("scheme=").append(scheme).append(';');
7006 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007007 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007008 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007009 }
7010 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007011 for (int i=0; i<mCategories.size(); i++) {
7012 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007013 }
7014 }
7015 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007016 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007017 }
7018 if (mFlags != 0) {
7019 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7020 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007021 if (mPackage != null) {
7022 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7023 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007024 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007025 uri.append("component=").append(Uri.encode(
7026 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007027 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007028 if (mSourceBounds != null) {
7029 uri.append("sourceBounds=")
7030 .append(Uri.encode(mSourceBounds.flattenToString()))
7031 .append(';');
7032 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007033 if (mExtras != null) {
7034 for (String key : mExtras.keySet()) {
7035 final Object value = mExtras.get(key);
7036 char entryType =
7037 value instanceof String ? 'S' :
7038 value instanceof Boolean ? 'B' :
7039 value instanceof Byte ? 'b' :
7040 value instanceof Character ? 'c' :
7041 value instanceof Double ? 'd' :
7042 value instanceof Float ? 'f' :
7043 value instanceof Integer ? 'i' :
7044 value instanceof Long ? 'l' :
7045 value instanceof Short ? 's' :
7046 '\0';
7047
7048 if (entryType != '\0') {
7049 uri.append(entryType);
7050 uri.append('.');
7051 uri.append(Uri.encode(key));
7052 uri.append('=');
7053 uri.append(Uri.encode(value.toString()));
7054 uri.append(';');
7055 }
7056 }
7057 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007058 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007059
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007060 public int describeContents() {
7061 return (mExtras != null) ? mExtras.describeContents() : 0;
7062 }
7063
7064 public void writeToParcel(Parcel out, int flags) {
7065 out.writeString(mAction);
7066 Uri.writeToParcel(out, mData);
7067 out.writeString(mType);
7068 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007069 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007070 ComponentName.writeToParcel(mComponent, out);
7071
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007072 if (mSourceBounds != null) {
7073 out.writeInt(1);
7074 mSourceBounds.writeToParcel(out, flags);
7075 } else {
7076 out.writeInt(0);
7077 }
7078
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007079 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007080 final int N = mCategories.size();
7081 out.writeInt(N);
7082 for (int i=0; i<N; i++) {
7083 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007084 }
7085 } else {
7086 out.writeInt(0);
7087 }
7088
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007089 if (mSelector != null) {
7090 out.writeInt(1);
7091 mSelector.writeToParcel(out, flags);
7092 } else {
7093 out.writeInt(0);
7094 }
7095
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007096 if (mClipData != null) {
7097 out.writeInt(1);
7098 mClipData.writeToParcel(out, flags);
7099 } else {
7100 out.writeInt(0);
7101 }
7102
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007103 out.writeBundle(mExtras);
7104 }
7105
7106 public static final Parcelable.Creator<Intent> CREATOR
7107 = new Parcelable.Creator<Intent>() {
7108 public Intent createFromParcel(Parcel in) {
7109 return new Intent(in);
7110 }
7111 public Intent[] newArray(int size) {
7112 return new Intent[size];
7113 }
7114 };
7115
Dianne Hackborneb034652009-09-07 00:49:58 -07007116 /** @hide */
7117 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007118 readFromParcel(in);
7119 }
7120
7121 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007122 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007123 mData = Uri.CREATOR.createFromParcel(in);
7124 mType = in.readString();
7125 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007126 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007127 mComponent = ComponentName.readFromParcel(in);
7128
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007129 if (in.readInt() != 0) {
7130 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7131 }
7132
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007133 int N = in.readInt();
7134 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007135 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007136 int i;
7137 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007138 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007139 }
7140 } else {
7141 mCategories = null;
7142 }
7143
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007144 if (in.readInt() != 0) {
7145 mSelector = new Intent(in);
7146 }
7147
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007148 if (in.readInt() != 0) {
7149 mClipData = new ClipData(in);
7150 }
7151
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007152 mExtras = in.readBundle();
7153 }
7154
7155 /**
7156 * Parses the "intent" element (and its children) from XML and instantiates
7157 * an Intent object. The given XML parser should be located at the tag
7158 * where parsing should start (often named "intent"), from which the
7159 * basic action, data, type, and package and class name will be
7160 * retrieved. The function will then parse in to any child elements,
7161 * looking for <category android:name="xxx"> tags to add categories and
7162 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7163 * to the intent.
7164 *
7165 * @param resources The Resources to use when inflating resources.
7166 * @param parser The XML parser pointing at an "intent" tag.
7167 * @param attrs The AttributeSet interface for retrieving extended
7168 * attribute data at the current <var>parser</var> location.
7169 * @return An Intent object matching the XML data.
7170 * @throws XmlPullParserException If there was an XML parsing error.
7171 * @throws IOException If there was an I/O error.
7172 */
7173 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7174 throws XmlPullParserException, IOException {
7175 Intent intent = new Intent();
7176
7177 TypedArray sa = resources.obtainAttributes(attrs,
7178 com.android.internal.R.styleable.Intent);
7179
7180 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7181
7182 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7183 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7184 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7185
7186 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7187 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7188 if (packageName != null && className != null) {
7189 intent.setComponent(new ComponentName(packageName, className));
7190 }
7191
7192 sa.recycle();
7193
7194 int outerDepth = parser.getDepth();
7195 int type;
7196 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7197 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7198 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7199 continue;
7200 }
7201
7202 String nodeName = parser.getName();
7203 if (nodeName.equals("category")) {
7204 sa = resources.obtainAttributes(attrs,
7205 com.android.internal.R.styleable.IntentCategory);
7206 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7207 sa.recycle();
7208
7209 if (cat != null) {
7210 intent.addCategory(cat);
7211 }
7212 XmlUtils.skipCurrentTag(parser);
7213
7214 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007215 if (intent.mExtras == null) {
7216 intent.mExtras = new Bundle();
7217 }
7218 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7219 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007220
7221 } else {
7222 XmlUtils.skipCurrentTag(parser);
7223 }
7224 }
7225
7226 return intent;
7227 }
Nick Pellyccae4122012-01-09 14:12:58 -08007228
7229 /**
7230 * Normalize a MIME data type.
7231 *
7232 * <p>A normalized MIME type has white-space trimmed,
7233 * content-type parameters removed, and is lower-case.
7234 * This aligns the type with Android best practices for
7235 * intent filtering.
7236 *
7237 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7238 * "text/x-vCard" becomes "text/x-vcard".
7239 *
7240 * <p>All MIME types received from outside Android (such as user input,
7241 * or external sources like Bluetooth, NFC, or the Internet) should
7242 * be normalized before they are used to create an Intent.
7243 *
7244 * @param type MIME data type to normalize
7245 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007246 * @see #setType
7247 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007248 */
7249 public static String normalizeMimeType(String type) {
7250 if (type == null) {
7251 return null;
7252 }
7253
Elliott Hughescb64d432013-08-02 10:00:44 -07007254 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007255
7256 final int semicolonIndex = type.indexOf(';');
7257 if (semicolonIndex != -1) {
7258 type = type.substring(0, semicolonIndex);
7259 }
7260 return type;
7261 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007262
7263 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007264 * Prepare this {@link Intent} to leave an app process.
7265 *
7266 * @hide
7267 */
7268 public void prepareToLeaveProcess() {
7269 setAllowFds(false);
7270
7271 if (mSelector != null) {
7272 mSelector.prepareToLeaveProcess();
7273 }
7274 if (mClipData != null) {
7275 mClipData.prepareToLeaveProcess();
7276 }
7277
7278 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7279 // There are several ACTION_MEDIA_* broadcasts that send file://
7280 // Uris, so only check common actions.
7281 if (ACTION_VIEW.equals(mAction) ||
7282 ACTION_EDIT.equals(mAction) ||
7283 ACTION_ATTACH_DATA.equals(mAction)) {
7284 mData.checkFileUriExposed("Intent.getData()");
7285 }
7286 }
7287 }
7288
7289 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007290 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007291 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7292 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007293 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007294 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007295 * @hide
7296 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007297 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007298 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007299 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007300
7301 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007302 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007303
7304 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007305 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007306 try {
7307 // Inspect target intent to see if we need to migrate
7308 final Intent target = getParcelableExtra(EXTRA_INTENT);
7309 if (target != null && target.migrateExtraStreamToClipData()) {
7310 // Since we migrated in child, we need to promote ClipData
7311 // and flags to ourselves to grant.
7312 setClipData(target.getClipData());
7313 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007314 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkeye66c1772013-09-20 14:30:59 -07007315 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007316 return true;
7317 } else {
7318 return false;
7319 }
7320 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007321 }
7322
7323 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007324 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007325 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7326 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7327 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7328 if (stream != null || text != null || htmlText != null) {
7329 final ClipData clipData = new ClipData(
7330 null, new String[] { getType() },
7331 new ClipData.Item(text, htmlText, null, stream));
7332 setClipData(clipData);
7333 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007334 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007335 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007336 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007337 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007338
7339 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007340 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007341 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7342 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7343 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7344 int num = -1;
7345 if (streams != null) {
7346 num = streams.size();
7347 }
7348 if (texts != null) {
7349 if (num >= 0 && num != texts.size()) {
7350 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007351 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007352 }
7353 num = texts.size();
7354 }
7355 if (htmlTexts != null) {
7356 if (num >= 0 && num != htmlTexts.size()) {
7357 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007358 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007359 }
7360 num = htmlTexts.size();
7361 }
7362 if (num > 0) {
7363 final ClipData clipData = new ClipData(
7364 null, new String[] { getType() },
7365 makeClipItem(streams, texts, htmlTexts, 0));
7366
7367 for (int i = 1; i < num; i++) {
7368 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7369 }
7370
7371 setClipData(clipData);
7372 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007373 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007374 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007375 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007376 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007377 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007378
7379 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007380 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007381
7382 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7383 ArrayList<String> htmlTexts, int which) {
7384 Uri uri = streams != null ? streams.get(which) : null;
7385 CharSequence text = texts != null ? texts.get(which) : null;
7386 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7387 return new ClipData.Item(text, htmlText, null, uri);
7388 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007389
7390 /** @hide */
7391 public boolean isDocument() {
7392 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7393 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007394}