blob: 421956bc9c7fed382b63fab7a94290b8a86dac6f [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 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001420 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1421 * <p>
1422 * For historical reasons, the name of this broadcast action refers to the power
1423 * state of the screen but it is actually sent in response to changes in the
1424 * overall interactive state of the device.
1425 * </p><p>
1426 * This broadcast is sent when the device becomes non-interactive which may have
1427 * nothing to do with the screen turning off. To determine the
1428 * actual state of the screen, use {@link android.view.Display#getState}.
1429 * </p><p>
1430 * See {@link android.os.PowerManager#isInteractive} for details.
1431 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001432 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001433 * <p class="note">This is a protected intent that can only be sent
1434 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001435 */
1436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1437 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001438
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001439 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001440 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1441 * <p>
1442 * For historical reasons, the name of this broadcast action refers to the power
1443 * state of the screen but it is actually sent in response to changes in the
1444 * overall interactive state of the device.
1445 * </p><p>
1446 * This broadcast is sent when the device becomes interactive which may have
1447 * nothing to do with the screen turning on. To determine the
1448 * actual state of the screen, use {@link android.view.Display#getState}.
1449 * </p><p>
1450 * See {@link android.os.PowerManager#isInteractive} for details.
1451 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001452 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001453 * <p class="note">This is a protected intent that can only be sent
1454 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001455 */
1456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1457 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001458
1459 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001460 * Broadcast Action: Sent after the system stops dreaming.
1461 *
1462 * <p class="note">This is a protected intent that can only be sent by the system.
1463 * It is only sent to registered receivers.</p>
1464 */
1465 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1466 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1467
1468 /**
1469 * Broadcast Action: Sent after the system starts dreaming.
1470 *
1471 * <p class="note">This is a protected intent that can only be sent by the system.
1472 * It is only sent to registered receivers.</p>
1473 */
1474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1475 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1476
1477 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001478 * 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 -07001479 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001480 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001481 * <p class="note">This is a protected intent that can only be sent
1482 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001483 */
1484 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001485 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001486
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001487 /**
1488 * Broadcast Action: The current time has changed. Sent every
1489 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001490 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001491 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1492 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001493 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001494 * <p class="note">This is a protected intent that can only be sent
1495 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1498 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1499 /**
1500 * Broadcast Action: The time was set.
1501 */
1502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1503 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1504 /**
1505 * Broadcast Action: The date has changed.
1506 */
1507 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1508 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1509 /**
1510 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1511 * <ul>
1512 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1513 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001514 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001515 * <p class="note">This is a protected intent that can only be sent
1516 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001517 */
1518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1519 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1520 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001521 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1522 * DNS entries should be tossed.
1523 * @hide
1524 */
1525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1526 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1527 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001528 * Alarm Changed Action: This is broadcast when the AlarmClock
1529 * application's alarm is set or unset. It is used by the
1530 * AlarmClock application and the StatusBar service.
1531 * @hide
1532 */
1533 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1534 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1535 /**
1536 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1537 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1538 * @hide
1539 */
1540 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1541 public static final String ACTION_SYNC_STATE_CHANGED
1542 = "android.intent.action.SYNC_STATE_CHANGED";
1543 /**
1544 * Broadcast Action: This is broadcast once, after the system has finished
1545 * booting. It can be used to perform application-specific initialization,
1546 * such as installing alarms. You must hold the
1547 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1548 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001549 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001550 * <p class="note">This is a protected intent that can only be sent
1551 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1555 /**
1556 * Broadcast Action: This is broadcast when a user action should request a
1557 * temporary system dialog to dismiss. Some examples of temporary system
1558 * dialogs are the notification window-shade and the recent tasks dialog.
1559 */
1560 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1561 /**
1562 * Broadcast Action: Trigger the download and eventual installation
1563 * of a package.
1564 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001565 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001566 * <p class="note">This is a protected intent that can only be sent
1567 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001568 *
1569 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001570 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001571 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001572 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1573 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1574 /**
1575 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001576 * device. The data contains the name of the package. Note that the
1577 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001578 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001579 * <ul>
1580 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1581 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1582 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1583 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001584 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001585 * <p class="note">This is a protected intent that can only be sent
1586 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 */
1588 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1589 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1590 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001591 * Broadcast Action: A new version of an application package has been
1592 * installed, replacing an existing version that was previously installed.
1593 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001594 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001595 * <ul>
1596 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1597 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001598 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001599 * <p class="note">This is a protected intent that can only be sent
1600 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001601 */
1602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1603 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1604 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001605 * Broadcast Action: A new version of your application has been installed
1606 * over an existing one. This is only sent to the application that was
1607 * replaced. It does not contain any additional data; to receive it, just
1608 * use an intent filter for this action.
1609 *
1610 * <p class="note">This is a protected intent that can only be sent
1611 * by the system.
1612 */
1613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1614 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1615 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001616 * Broadcast Action: An existing application package has been removed from
1617 * the device. The data contains the name of the package. The package
1618 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001619 * <ul>
1620 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1621 * to the package.
1622 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1623 * application -- data and code -- is being removed.
1624 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1625 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1626 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001627 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001628 * <p class="note">This is a protected intent that can only be sent
1629 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001630 */
1631 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1632 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1633 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001634 * Broadcast Action: An existing application package has been completely
1635 * removed from the device. The data contains the name of the package.
1636 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1637 * {@link #EXTRA_DATA_REMOVED} is true and
1638 * {@link #EXTRA_REPLACING} is false of that broadcast.
1639 *
1640 * <ul>
1641 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1642 * to the package.
1643 * </ul>
1644 *
1645 * <p class="note">This is a protected intent that can only be sent
1646 * by the system.
1647 */
1648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1649 public static final String ACTION_PACKAGE_FULLY_REMOVED
1650 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1651 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001652 * Broadcast Action: An existing application package has been changed (e.g.
1653 * a component has been enabled or disabled). The data contains the name of
1654 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001655 * <ul>
1656 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001657 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001658 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001659 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1660 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001662 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001663 * <p class="note">This is a protected intent that can only be sent
1664 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001665 */
1666 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1667 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1668 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001669 * @hide
1670 * Broadcast Action: Ask system services if there is any reason to
1671 * restart the given package. The data contains the name of the
1672 * package.
1673 * <ul>
1674 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1675 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1676 * </ul>
1677 *
1678 * <p class="note">This is a protected intent that can only be sent
1679 * by the system.
1680 */
1681 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1682 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1683 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001684 * Broadcast Action: The user has restarted a package, and all of its
1685 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001686 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001687 * be removed. Note that the restarted package does <em>not</em>
1688 * receive this broadcast.
1689 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001690 * <ul>
1691 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1692 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001693 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001694 * <p class="note">This is a protected intent that can only be sent
1695 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001696 */
1697 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1698 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1699 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001700 * Broadcast Action: The user has cleared the data of a package. This should
1701 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001702 * its persistent data is erased and this broadcast sent.
1703 * Note that the cleared package does <em>not</em>
1704 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001705 * <ul>
1706 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1707 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001708 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001709 * <p class="note">This is a protected intent that can only be sent
1710 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001711 */
1712 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1713 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1714 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001715 * Broadcast Action: A user ID has been removed from the system. The user
1716 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001717 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001718 * <p class="note">This is a protected intent that can only be sent
1719 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001720 */
1721 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1722 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001723
1724 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001725 * Broadcast Action: Sent to the installer package of an application
1726 * when that application is first launched (that is the first time it
1727 * is moved out of the stopped state). The data contains the name of the package.
1728 *
1729 * <p class="note">This is a protected intent that can only be sent
1730 * by the system.
1731 */
1732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1733 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1734
1735 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001736 * Broadcast Action: Sent to the system package verifier when a package
1737 * needs to be verified. The data contains the package URI.
1738 * <p class="note">
1739 * This is a protected intent that can only be sent by the system.
1740 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001741 */
1742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1743 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1744
1745 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001746 * Broadcast Action: Sent to the system package verifier when a package is
1747 * verified. The data contains the package URI.
1748 * <p class="note">
1749 * This is a protected intent that can only be sent by the system.
1750 */
1751 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1752 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1753
1754 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001755 * Broadcast Action: Resources for a set of packages (which were
1756 * previously unavailable) are currently
1757 * available since the media on which they exist is available.
1758 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1759 * list of packages whose availability changed.
1760 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1761 * list of uids of packages whose availability changed.
1762 * Note that the
1763 * packages in this list do <em>not</em> receive this broadcast.
1764 * The specified set of packages are now available on the system.
1765 * <p>Includes the following extras:
1766 * <ul>
1767 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1768 * whose resources(were previously unavailable) are currently available.
1769 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1770 * packages whose resources(were previously unavailable)
1771 * are currently available.
1772 * </ul>
1773 *
1774 * <p class="note">This is a protected intent that can only be sent
1775 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001776 */
1777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001778 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1779 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001780
1781 /**
1782 * Broadcast Action: Resources for a set of packages are currently
1783 * unavailable since the media on which they exist is unavailable.
1784 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1785 * list of packages whose availability changed.
1786 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1787 * list of uids of packages whose availability changed.
1788 * The specified set of packages can no longer be
1789 * launched and are practically unavailable on the system.
1790 * <p>Inclues the following extras:
1791 * <ul>
1792 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1793 * whose resources are no longer available.
1794 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1795 * whose resources are no longer available.
1796 * </ul>
1797 *
1798 * <p class="note">This is a protected intent that can only be sent
1799 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001800 */
1801 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001802 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001803 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001804
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001805 /**
1806 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001807 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001808 * This should <em>only</em> be used to determine when the wallpaper
1809 * has changed to show the new wallpaper to the user. You should certainly
1810 * never, in response to this, change the wallpaper or other attributes of
1811 * it such as the suggested size. That would be crazy, right? You'd cause
1812 * all kinds of loops, especially if other apps are doing similar things,
1813 * right? Of course. So please don't do this.
1814 *
1815 * @deprecated Modern applications should use
1816 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1817 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1818 * shown behind their UI, rather than watching for this broadcast and
1819 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001820 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001821 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001822 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1823 /**
1824 * Broadcast Action: The current device {@link android.content.res.Configuration}
1825 * (orientation, locale, etc) has changed. When such a change happens, the
1826 * UIs (view hierarchy) will need to be rebuilt based on this new
1827 * information; for the most part, applications don't need to worry about
1828 * this, because the system will take care of stopping and restarting the
1829 * application to make sure it sees the new changes. Some system code that
1830 * can not be restarted will need to watch for this action and handle it
1831 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001832 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001833 * <p class="note">
1834 * You can <em>not</em> receive this through components declared
1835 * in manifests, only by explicitly registering for it with
1836 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1837 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001838 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001839 * <p class="note">This is a protected intent that can only be sent
1840 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001841 *
1842 * @see android.content.res.Configuration
1843 */
1844 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1845 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1846 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001847 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001848 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001849 * <p class="note">This is a protected intent that can only be sent
1850 * by the system.
1851 */
1852 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1853 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1854 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001855 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1856 * charging state, level, and other information about the battery.
1857 * See {@link android.os.BatteryManager} for documentation on the
1858 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001859 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001860 * <p class="note">
1861 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001862 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001863 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001864 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1865 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1866 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1867 * broadcasts that are sent and can be received through manifest
1868 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001869 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001870 * <p class="note">This is a protected intent that can only be sent
1871 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001872 */
1873 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1874 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1875 /**
1876 * Broadcast Action: Indicates low battery condition on the device.
1877 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001878 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001879 * <p class="note">This is a protected intent that can only be sent
1880 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1884 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001885 * Broadcast Action: Indicates the battery is now okay after being low.
1886 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1887 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001888 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001889 * <p class="note">This is a protected intent that can only be sent
1890 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001891 */
1892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1893 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1894 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001895 * Broadcast Action: External power has been connected to the device.
1896 * This is intended for applications that wish to register specifically to this notification.
1897 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1898 * stay active to receive this notification. This action can be used to implement actions
1899 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001900 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001901 * <p class="note">This is a protected intent that can only be sent
1902 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001903 */
1904 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001905 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001906 /**
1907 * Broadcast Action: External power has been removed from the device.
1908 * This is intended for applications that wish to register specifically to this notification.
1909 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1910 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001911 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001912 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001913 * <p class="note">This is a protected intent that can only be sent
1914 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001915 */
1916 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001917 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001918 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001919 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001920 * Broadcast Action: Device is shutting down.
1921 * This is broadcast when the device is being shut down (completely turned
1922 * off, not sleeping). Once the broadcast is complete, the final shutdown
1923 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001924 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001925 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001926 * <p class="note">This is a protected intent that can only be sent
1927 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001928 * <p>May include the following extras:
1929 * <ul>
1930 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1931 * shutdown is only for userspace processes. If not set, assumed to be false.
1932 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001935 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001936 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001937 * Activity Action: Start this activity to request system shutdown.
1938 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1939 * to request confirmation from the user before shutting down.
1940 *
1941 * <p class="note">This is a protected intent that can only be sent
1942 * by the system.
1943 *
1944 * {@hide}
1945 */
1946 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1947 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001948 * Broadcast Action: A sticky broadcast that indicates low memory
1949 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001950 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001951 * <p class="note">This is a protected intent that can only be sent
1952 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001953 */
1954 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1955 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1956 /**
1957 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001958 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001959 * <p class="note">This is a protected intent that can only be sent
1960 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1964 /**
Jake Hambybb371632010-08-23 18:16:48 -07001965 * Broadcast Action: A sticky broadcast that indicates a memory full
1966 * condition on the device. This is intended for activities that want
1967 * to be able to fill the data partition completely, leaving only
1968 * enough free space to prevent system-wide SQLite failures.
1969 *
1970 * <p class="note">This is a protected intent that can only be sent
1971 * by the system.
1972 *
1973 * {@hide}
1974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1976 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1977 /**
1978 * Broadcast Action: Indicates memory full condition on the device
1979 * no longer exists.
1980 *
1981 * <p class="note">This is a protected intent that can only be sent
1982 * by the system.
1983 *
1984 * {@hide}
1985 */
1986 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1987 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1988 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001989 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1990 * and package management should be started.
1991 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1992 * notification.
1993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1996 /**
1997 * Broadcast Action: The device has entered USB Mass Storage mode.
1998 * This is used mainly for the USB Settings panel.
1999 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2000 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002001 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002002 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002003 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002004 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2005
2006 /**
2007 * Broadcast Action: The device has exited USB Mass Storage mode.
2008 * This is used mainly for the USB Settings panel.
2009 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2010 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002011 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002013 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002014 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2015
2016 /**
2017 * Broadcast Action: External media has been removed.
2018 * The path to the mount point for the removed media is contained in the Intent.mData field.
2019 */
2020 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2021 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2022
2023 /**
2024 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002025 * 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 -07002026 */
2027 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2028 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2029
2030 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002031 * Broadcast Action: External media is present, and being disk-checked
2032 * 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 -08002033 */
2034 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2035 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2036
2037 /**
2038 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2039 * 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 -08002040 */
2041 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2042 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2043
2044 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002045 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002046 * 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 -07002047 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2048 * media was mounted read only.
2049 */
2050 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2051 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2052
2053 /**
2054 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002055 * 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 -07002056 */
2057 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2058 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2059
2060 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002061 * Broadcast Action: External media is no longer being shared via USB mass storage.
2062 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2063 *
2064 * @hide
2065 */
2066 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2067
2068 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002069 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2070 * The path to the mount point for the removed media is contained in the Intent.mData field.
2071 */
2072 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2073 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2074
2075 /**
2076 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002077 * 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 -07002078 */
2079 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2080 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2081
2082 /**
2083 * Broadcast Action: User has expressed the desire to remove the external storage media.
2084 * Applications should close all files they have open within the mount point when they receive this intent.
2085 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2086 */
2087 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2088 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2089
2090 /**
2091 * Broadcast Action: The media scanner has started scanning a directory.
2092 * The path to the directory being scanned is contained in the Intent.mData field.
2093 */
2094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2096
2097 /**
2098 * Broadcast Action: The media scanner has finished scanning a directory.
2099 * The path to the scanned directory is contained in the Intent.mData field.
2100 */
2101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2102 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2103
2104 /**
2105 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2106 * The path to the file is contained in the Intent.mData field.
2107 */
2108 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2109 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2110
2111 /**
2112 * Broadcast Action: The "Media Button" was pressed. Includes a single
2113 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2114 * caused the broadcast.
2115 */
2116 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2117 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2118
2119 /**
2120 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2121 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2122 * caused the broadcast.
2123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2126
2127 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2128 // location; they are not general-purpose actions.
2129
2130 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002131 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 */
2133 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2134 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2135 "android.intent.action.GTALK_CONNECTED";
2136
2137 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002138 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002139 */
2140 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2141 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2142 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002143
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002144 /**
2145 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002146 */
2147 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2148 public static final String ACTION_INPUT_METHOD_CHANGED =
2149 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002150
2151 /**
2152 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2153 * more radios have been turned off or on. The intent will have the following extra value:</p>
2154 * <ul>
2155 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2156 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2157 * turned off</li>
2158 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002159 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002160 * <p class="note">This is a protected intent that can only be sent
2161 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002162 */
2163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2164 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2165
2166 /**
2167 * Broadcast Action: Some content providers have parts of their namespace
2168 * where they publish new events or items that the user may be especially
2169 * interested in. For these things, they may broadcast this action when the
2170 * set of interesting items change.
2171 *
2172 * For example, GmailProvider sends this notification when the set of unread
2173 * mail in the inbox changes.
2174 *
2175 * <p>The data of the intent identifies which part of which provider
2176 * changed. When queried through the content resolver, the data URI will
2177 * return the data set in question.
2178 *
2179 * <p>The intent will have the following extra values:
2180 * <ul>
2181 * <li><em>count</em> - The number of items in the data set. This is the
2182 * same as the number of items in the cursor returned by querying the
2183 * data URI. </li>
2184 * </ul>
2185 *
2186 * This intent will be sent at boot (if the count is non-zero) and when the
2187 * data set changes. It is possible for the data set to change without the
2188 * count changing (for example, if a new unread message arrives in the same
2189 * sync operation in which a message is archived). The phone should still
2190 * ring/vibrate/etc as normal in this case.
2191 */
2192 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193 public static final String ACTION_PROVIDER_CHANGED =
2194 "android.intent.action.PROVIDER_CHANGED";
2195
2196 /**
2197 * Broadcast Action: Wired Headset plugged in or unplugged.
2198 *
Matt Casey79867f52014-03-26 15:20:25 -07002199 * You <em>cannot</em> receive this through components declared
2200 * in manifests, only by explicitly registering for it with
2201 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2202 * Context.registerReceiver()}.
2203 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002204 * <p>The intent will have the following extra values:
2205 * <ul>
2206 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2207 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002208 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002209 * </ul>
2210 * </ul>
2211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_HEADSET_PLUG =
2214 "android.intent.action.HEADSET_PLUG";
2215
2216 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002217 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2218 *
2219 * <p>The intent will have the following extra values:
2220 * <ul>
2221 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2222 * <li><em>name</em> - Headset type, human readable string </li>
2223 * </ul>
2224 * </ul>
2225 * @hide
2226 */
2227 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002228 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2229 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002230
2231 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002232 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002233 *
2234 * <p>The intent will have the following extra values:
2235 * <ul>
2236 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2237 * <li><em>name</em> - Headset type, human readable string </li>
2238 * </ul>
2239 * </ul>
2240 * @hide
2241 */
2242 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002243 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2244 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002245
2246 /**
2247 * Broadcast Action: A HMDI cable was plugged or unplugged
2248 *
2249 * <p>The intent will have the following extra values:
2250 * <ul>
2251 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2252 * <li><em>name</em> - HDMI cable, human readable string </li>
2253 * </ul>
2254 * </ul>
2255 * @hide
2256 */
2257 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2258 public static final String ACTION_HDMI_AUDIO_PLUG =
2259 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002260
2261 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002262 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2263 *
2264 * <p>The intent will have the following extra values:
2265 * <ul>
2266 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2267 * <li><em>card</em> - ALSA card number (integer) </li>
2268 * <li><em>device</em> - ALSA device number (integer) </li>
2269 * </ul>
2270 * </ul>
2271 * @hide
2272 */
2273 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2274 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2275 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2276
2277 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002278 * Broadcast Action: A USB audio device was plugged in or unplugged.
2279 *
2280 * <p>The intent will have the following extra values:
2281 * <ul>
2282 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2283 * <li><em>card</em> - ALSA card number (integer) </li>
2284 * <li><em>device</em> - ALSA device number (integer) </li>
2285 * </ul>
2286 * </ul>
2287 * @hide
2288 */
2289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2290 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2291 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2292
2293 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002294 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2295 * <ul>
2296 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2297 * </ul>
2298 *
2299 * <p class="note">This is a protected intent that can only be sent
2300 * by the system.
2301 *
2302 * @hide
2303 */
2304 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2305 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2306 = "android.intent.action.ADVANCED_SETTINGS";
2307
2308 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002309 * Broadcast Action: Sent after application restrictions are changed.
2310 *
2311 * <p class="note">This is a protected intent that can only be sent
2312 * by the system.</p>
2313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2316 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2317
2318 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002319 * Broadcast Action: An outgoing call is about to be placed.
2320 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002321 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002322 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002323 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 * the phone number originally intended to be dialed.</li>
2325 * </ul>
2326 * <p>Once the broadcast is finished, the resultData is used as the actual
2327 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002328 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002329 * outgoing call in turn: for example, a parental control application
2330 * might verify that the user is authorized to place the call at that
2331 * time, then a number-rewriting application might add an area code if
2332 * one was not specified.</p>
2333 * <p>For consistency, any receiver whose purpose is to prohibit phone
2334 * calls should have a priority of 0, to ensure it will see the final
2335 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002336 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002337 * should have a positive priority.
2338 * Negative priorities are reserved for the system for this broadcast;
2339 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002340 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2341 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002342 * <p>Emergency calls cannot be intercepted using this mechanism, and
2343 * other calls cannot be modified to call emergency numbers using this
2344 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002345 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2346 * call to use their own service instead. Those apps should first prevent
2347 * the call from being placed by setting resultData to <code>null</code>
2348 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002349 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002350 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2351 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002352 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002353 * <p class="note">This is a protected intent that can only be sent
2354 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002355 */
2356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2357 public static final String ACTION_NEW_OUTGOING_CALL =
2358 "android.intent.action.NEW_OUTGOING_CALL";
2359
2360 /**
2361 * Broadcast Action: Have the device reboot. This is only for use by
2362 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002363 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002364 * <p class="note">This is a protected intent that can only be sent
2365 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002366 */
2367 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2368 public static final String ACTION_REBOOT =
2369 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002370
Wei Huang97ecc9c2009-05-11 17:44:20 -07002371 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002372 * Broadcast Action: A sticky broadcast for changes in the physical
2373 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002374 *
2375 * <p>The intent will have the following extra values:
2376 * <ul>
2377 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002378 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002379 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002380 * <p>This is intended for monitoring the current physical dock state.
2381 * See {@link android.app.UiModeManager} for the normal API dealing with
2382 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002383 */
2384 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2385 public static final String ACTION_DOCK_EVENT =
2386 "android.intent.action.DOCK_EVENT";
2387
2388 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002389 * Broadcast Action: A broadcast when idle maintenance can be started.
2390 * This means that the user is not interacting with the device and is
2391 * not expected to do so soon. Typical use of the idle maintenance is
2392 * to perform somehow expensive tasks that can be postponed at a moment
2393 * when they will not degrade user experience.
2394 * <p>
2395 * <p class="note">In order to keep the device responsive in case of an
2396 * unexpected user interaction, implementations of a maintenance task
2397 * should be interruptible. In such a scenario a broadcast with action
2398 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2399 * should not do the maintenance work in
2400 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2401 * maintenance service by {@link Context#startService(Intent)}. Also
2402 * you should hold a wake lock while your maintenance service is running
2403 * to prevent the device going to sleep.
2404 * </p>
2405 * <p>
2406 * <p class="note">This is a protected intent that can only be sent by
2407 * the system.
2408 * </p>
2409 *
2410 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002411 *
2412 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002413 */
2414 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2415 public static final String ACTION_IDLE_MAINTENANCE_START =
2416 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2417
2418 /**
2419 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2420 * This means that the user was not interacting with the device as a result
2421 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2422 * was sent and now the user started interacting with the device. Typical
2423 * use of the idle maintenance is to perform somehow expensive tasks that
2424 * can be postponed at a moment when they will not degrade user experience.
2425 * <p>
2426 * <p class="note">In order to keep the device responsive in case of an
2427 * unexpected user interaction, implementations of a maintenance task
2428 * should be interruptible. Hence, on receiving a broadcast with this
2429 * action, the maintenance task should be interrupted as soon as possible.
2430 * In other words, you should not do the maintenance work in
2431 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2432 * maintenance service that was started on receiving of
2433 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2434 * lock you acquired when your maintenance service started.
2435 * </p>
2436 * <p class="note">This is a protected intent that can only be sent
2437 * by the system.
2438 *
2439 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002440 *
2441 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002442 */
2443 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2444 public static final String ACTION_IDLE_MAINTENANCE_END =
2445 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2446
2447 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002448 * Broadcast Action: a remote intent is to be broadcasted.
2449 *
2450 * A remote intent is used for remote RPC between devices. The remote intent
2451 * is serialized and sent from one device to another device. The receiving
2452 * device parses the remote intent and broadcasts it. Note that anyone can
2453 * broadcast a remote intent. However, if the intent receiver of the remote intent
2454 * does not trust intent broadcasts from arbitrary intent senders, it should require
2455 * the sender to hold certain permissions so only trusted sender's broadcast will be
2456 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002457 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002458 */
2459 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002460 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002461
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002462 /**
2463 * Broadcast Action: hook for permforming cleanup after a system update.
2464 *
2465 * The broadcast is sent when the system is booting, before the
2466 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2467 * image. A receiver for this should do its work and then disable itself
2468 * so that it does not get run again at the next boot.
2469 * @hide
2470 */
2471 public static final String ACTION_PRE_BOOT_COMPLETED =
2472 "android.intent.action.PRE_BOOT_COMPLETED";
2473
Amith Yamasani13593602012-03-22 16:16:17 -07002474 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002475 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002476 * on restricted users. The broadcast intent contains an extra
2477 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2478 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2479 * String[] depending on the restriction type.<p/>
2480 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002481 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2482 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2483 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002484 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2485 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002486 * @see RestrictionEntry
2487 */
2488 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2489 "android.intent.action.GET_RESTRICTION_ENTRIES";
2490
2491 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002492 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002493 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002494 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2495 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2496 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002497 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2498 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2499 * challenge.<p/>
2500 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002501 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002502 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002503 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2504 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002505
2506 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002507 * Sent the first time a user is starting, to allow system apps to
2508 * perform one time initialization. (This will not be seen by third
2509 * party applications because a newly initialized user does not have any
2510 * third party applications installed for it.) This is sent early in
2511 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002512 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2513 * broadcast, since it is part of a visible user interaction; be as quick
2514 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002515 */
2516 public static final String ACTION_USER_INITIALIZE =
2517 "android.intent.action.USER_INITIALIZE";
2518
2519 /**
2520 * Sent when a user switch is happening, causing the process's user to be
2521 * brought to the foreground. This is only sent to receivers registered
2522 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2523 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002524 * foreground. This is sent as a foreground
2525 * broadcast, since it is part of a visible user interaction; be as quick
2526 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002527 */
2528 public static final String ACTION_USER_FOREGROUND =
2529 "android.intent.action.USER_FOREGROUND";
2530
2531 /**
2532 * Sent when a user switch is happening, causing the process's user to be
2533 * sent to the background. This is only sent to receivers registered
2534 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2535 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002536 * background. This is sent as a foreground
2537 * broadcast, since it is part of a visible user interaction; be as quick
2538 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002539 */
2540 public static final String ACTION_USER_BACKGROUND =
2541 "android.intent.action.USER_BACKGROUND";
2542
2543 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002544 * Broadcast sent to the system when a user is added. Carries an extra
2545 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2546 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002547 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002548 * @hide
2549 */
2550 public static final String ACTION_USER_ADDED =
2551 "android.intent.action.USER_ADDED";
2552
2553 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002554 * Broadcast sent by the system when a user is started. Carries an extra
2555 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002556 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002557 * that has been started. This is sent as a foreground
2558 * broadcast, since it is part of a visible user interaction; be as quick
2559 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002560 * @hide
2561 */
2562 public static final String ACTION_USER_STARTED =
2563 "android.intent.action.USER_STARTED";
2564
2565 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002566 * Broadcast sent when a user is in the process of starting. Carries an extra
2567 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2568 * sent to registered receivers, not manifest receivers. It is sent to all
2569 * users (including the one that is being started). You must hold
2570 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2571 * this broadcast. This is sent as a background broadcast, since
2572 * its result is not part of the primary UX flow; to safely keep track of
2573 * started/stopped state of a user you can use this in conjunction with
2574 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2575 * other user state broadcasts since those are foreground broadcasts so can
2576 * execute in a different order.
2577 * @hide
2578 */
2579 public static final String ACTION_USER_STARTING =
2580 "android.intent.action.USER_STARTING";
2581
2582 /**
2583 * Broadcast sent when a user is going to be stopped. Carries an extra
2584 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2585 * sent to registered receivers, not manifest receivers. It is sent to all
2586 * users (including the one that is being stopped). You must hold
2587 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2588 * this broadcast. The user will not stop until all receivers have
2589 * handled the broadcast. This is sent as a background broadcast, since
2590 * its result is not part of the primary UX flow; to safely keep track of
2591 * started/stopped state of a user you can use this in conjunction with
2592 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2593 * other user state broadcasts since those are foreground broadcasts so can
2594 * execute in a different order.
2595 * @hide
2596 */
2597 public static final String ACTION_USER_STOPPING =
2598 "android.intent.action.USER_STOPPING";
2599
2600 /**
2601 * Broadcast sent to the system when a user is stopped. Carries an extra
2602 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2603 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2604 * specific package. This is only sent to registered receivers, not manifest
2605 * receivers. It is sent to all running users <em>except</em> the one that
2606 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002607 * @hide
2608 */
2609 public static final String ACTION_USER_STOPPED =
2610 "android.intent.action.USER_STOPPED";
2611
2612 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002613 * 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 -07002614 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002615 * one that has been removed. The user will not be completely removed until all receivers have
2616 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002617 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002618 * @hide
2619 */
2620 public static final String ACTION_USER_REMOVED =
2621 "android.intent.action.USER_REMOVED";
2622
2623 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002624 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002625 * the userHandle of the user to become the current one. This is only sent to
2626 * registered receivers, not manifest receivers. It is sent to all running users.
2627 * You must hold
2628 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002629 * @hide
2630 */
2631 public static final String ACTION_USER_SWITCHED =
2632 "android.intent.action.USER_SWITCHED";
2633
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002634 /**
2635 * Broadcast sent to the system when a user's information changes. Carries an extra
2636 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002637 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002638 * @hide
2639 */
2640 public static final String ACTION_USER_INFO_CHANGED =
2641 "android.intent.action.USER_INFO_CHANGED";
2642
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002643 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002644 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2645 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
2646 * the UserHandle of the profile that was added. This is only sent to registered receivers,
2647 * not manifest receivers.
2648 */
2649 public static final String ACTION_MANAGED_PROFILE_ADDED =
2650 "android.intent.action.MANAGED_PROFILE_ADDED";
2651
2652 /**
2653 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
2654 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed. This
2655 * is only sent to registered receivers, not manifest receivers.
2656 */
2657 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2658 "android.intent.action.MANAGED_PROFILE_REMOVED";
2659
2660 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002661 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2662 */
2663 public static final String ACTION_QUICK_CLOCK =
2664 "android.intent.action.QUICK_CLOCK";
2665
Michael Wright0087a142013-02-05 16:29:39 -08002666 /**
2667 * Broadcast Action: This is broadcast when a user action should request the
2668 * brightness setting dialog.
2669 * @hide
2670 */
2671 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2672 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2673
Justin Kohd378ad72013-04-01 12:18:26 -07002674 /**
2675 * Broadcast Action: A global button was pressed. Includes a single
2676 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2677 * caused the broadcast.
2678 * @hide
2679 */
2680 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2681
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002682 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002683 * Activity Action: Allow the user to select and return one or more existing
2684 * documents. When invoked, the system will display the various
2685 * {@link DocumentsProvider} instances installed on the device, letting the
2686 * user interactively navigate through them. These documents include local
2687 * media, such as photos and video, and documents provided by installed
2688 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002689 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002690 * Each document is represented as a {@code content://} URI backed by a
2691 * {@link DocumentsProvider}, which can be opened as a stream with
2692 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2693 * {@link android.provider.DocumentsContract.Document} metadata.
2694 * <p>
2695 * All selected documents are returned to the calling application with
2696 * persistable read and write permission grants. If you want to maintain
2697 * access to the documents across device reboots, you need to explicitly
2698 * take the persistable permissions using
2699 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2700 * <p>
2701 * Callers can restrict document selection to a specific kind of data, such
2702 * as photos, by setting one or more MIME types in
2703 * {@link #EXTRA_MIME_TYPES}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002704 * <p>
2705 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002706 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2707 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002708 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002709 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2710 * returned URIs can be opened with
2711 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002712 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002713 * Output: The URI of the item that was picked. This must be a
2714 * {@code content://} URI so that any receiver can access it. If multiple
2715 * documents were selected, they are returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002716 *
2717 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002718 * @see #ACTION_CREATE_DOCUMENT
2719 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002720 */
2721 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2722 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2723
2724 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002725 * Activity Action: Allow the user to create a new document. When invoked,
2726 * the system will display the various {@link DocumentsProvider} instances
2727 * installed on the device, letting the user navigate through them. The
2728 * returned document may be a newly created document with no content, or it
2729 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002730 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002731 * Each document is represented as a {@code content://} URI backed by a
2732 * {@link DocumentsProvider}, which can be opened as a stream with
2733 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2734 * {@link android.provider.DocumentsContract.Document} metadata.
2735 * <p>
2736 * Callers must indicate the concrete MIME type of the document being
2737 * created by setting {@link #setType(String)}. This MIME type cannot be
2738 * changed after the document is created.
2739 * <p>
2740 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2741 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002742 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002743 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2744 * returned URIs can be opened with
2745 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002746 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002747 * Output: The URI of the item that was created. This must be a
2748 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002749 *
2750 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002751 * @see #ACTION_OPEN_DOCUMENT
2752 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002753 */
2754 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2755 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2756
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002757 // ---------------------------------------------------------------------
2758 // ---------------------------------------------------------------------
2759 // Standard intent categories (see addCategory()).
2760
2761 /**
2762 * Set if the activity should be an option for the default action
2763 * (center press) to perform on a piece of data. Setting this will
2764 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002765 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002766 * Intent when initiating an action -- it is for use in intent filters
2767 * specified in packages.
2768 */
2769 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2770 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2771 /**
2772 * Activities that can be safely invoked from a browser must support this
2773 * category. For example, if the user is viewing a web page or an e-mail
2774 * and clicks on a link in the text, the Intent generated execute that
2775 * link will require the BROWSABLE category, so that only activities
2776 * supporting this category will be considered as possible actions. By
2777 * supporting this category, you are promising that there is nothing
2778 * damaging (without user intervention) that can happen by invoking any
2779 * matching Intent.
2780 */
2781 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2782 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2783 /**
2784 * Set if the activity should be considered as an alternative action to
2785 * the data the user is currently viewing. See also
2786 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2787 * applies to the selection in a list of items.
2788 *
2789 * <p>Supporting this category means that you would like your activity to be
2790 * displayed in the set of alternative things the user can do, usually as
2791 * part of the current activity's options menu. You will usually want to
2792 * include a specific label in the &lt;intent-filter&gt; of this action
2793 * describing to the user what it does.
2794 *
2795 * <p>The action of IntentFilter with this category is important in that it
2796 * describes the specific action the target will perform. This generally
2797 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2798 * a specific name such as "com.android.camera.action.CROP. Only one
2799 * alternative of any particular action will be shown to the user, so using
2800 * a specific action like this makes sure that your alternative will be
2801 * displayed while also allowing other applications to provide their own
2802 * overrides of that particular action.
2803 */
2804 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2805 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2806 /**
2807 * Set if the activity should be considered as an alternative selection
2808 * action to the data the user has currently selected. This is like
2809 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2810 * of items from which the user can select, giving them alternatives to the
2811 * default action that will be performed on it.
2812 */
2813 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2814 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2815 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002816 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002817 */
2818 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2819 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2820 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002821 * Should be displayed in the top-level launcher.
2822 */
2823 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2824 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2825 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002826 * Indicates an activity optimized for Leanback mode, and that should
2827 * be displayed in the Leanback launcher.
2828 */
2829 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2830 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2831 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002832 * Provides information about the package it is in; typically used if
2833 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2834 * a front-door to the user without having to be shown in the all apps list.
2835 */
2836 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2837 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2838 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002839 * This is the home activity, that is the first activity that is displayed
2840 * when the device boots.
2841 */
2842 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2843 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2844 /**
2845 * This activity is a preference panel.
2846 */
2847 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2848 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2849 /**
2850 * This activity is a development preference panel.
2851 */
2852 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2853 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2854 /**
2855 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002856 */
2857 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2858 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2859 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002860 * This activity allows the user to browse and download new applications.
2861 */
2862 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2863 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2864 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002865 * This activity may be exercised by the monkey or other automated test tools.
2866 */
2867 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2868 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2869 /**
2870 * To be used as a test (not part of the normal user experience).
2871 */
2872 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2873 /**
2874 * To be used as a unit test (run through the Test Harness).
2875 */
2876 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2877 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002878 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002879 * experience).
2880 */
2881 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002883 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002884 * Used to indicate that an intent only wants URIs that can be opened with
2885 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2886 * must support at least the columns defined in {@link OpenableColumns} when
2887 * queried.
2888 *
2889 * @see #ACTION_GET_CONTENT
2890 * @see #ACTION_OPEN_DOCUMENT
2891 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002892 */
2893 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2894 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2895
2896 /**
2897 * To be used as code under test for framework instrumentation tests.
2898 */
2899 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2900 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002901 /**
2902 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002903 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2904 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002905 */
2906 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2907 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2908 /**
2909 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002910 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2911 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002912 */
2913 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2914 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002915 /**
2916 * An activity to run when device is inserted into a analog (low end) dock.
2917 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2918 * information, see {@link android.app.UiModeManager}.
2919 */
2920 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2921 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2922
2923 /**
2924 * An activity to run when device is inserted into a digital (high end) dock.
2925 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2926 * information, see {@link android.app.UiModeManager}.
2927 */
2928 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2929 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002930
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002931 /**
2932 * Used to indicate that the activity can be used in a car environment.
2933 */
2934 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2935 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2936
Dan Sandlera55734a2014-03-26 18:41:11 -04002937 /**
2938 * An activity that provides a user interface for adjusting notification preferences for its
2939 * containing application. Optional but recommended for apps that post
2940 * {@link android.app.Notification Notifications}.
2941 */
2942 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2943 public static final String CATEGORY_NOTIFICATION_PREFERENCES = "android.intent.category.NOTIFICATION_PREFERENCES";
2944
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002945 // ---------------------------------------------------------------------
2946 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002947 // Application launch intent categories (see addCategory()).
2948
2949 /**
2950 * Used with {@link #ACTION_MAIN} to launch the browser application.
2951 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002952 * <p>NOTE: This should not be used as the primary key of an Intent,
2953 * since it will not result in the app launching with the correct
2954 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002955 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002956 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002957 */
2958 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2959 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2960
2961 /**
2962 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2963 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002964 * <p>NOTE: This should not be used as the primary key of an Intent,
2965 * since it will not result in the app launching with the correct
2966 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002967 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002968 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002969 */
2970 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2971 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2972
2973 /**
2974 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2975 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002976 * <p>NOTE: This should not be used as the primary key of an Intent,
2977 * since it will not result in the app launching with the correct
2978 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002979 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002980 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002981 */
2982 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2983 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2984
2985 /**
2986 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2987 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002988 * <p>NOTE: This should not be used as the primary key of an Intent,
2989 * since it will not result in the app launching with the correct
2990 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002991 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002992 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002993 */
2994 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2995 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2996
2997 /**
2998 * Used with {@link #ACTION_MAIN} to launch the email application.
2999 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003000 * <p>NOTE: This should not be used as the primary key of an Intent,
3001 * since it will not result in the app launching with the correct
3002 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003003 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003004 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003005 */
3006 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3007 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3008
3009 /**
3010 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3011 * The activity should be able to view and manipulate image and video files
3012 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003013 * <p>NOTE: This should not be used as the primary key of an Intent,
3014 * since it will not result in the app launching with the correct
3015 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003016 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003017 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003018 */
3019 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3020 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3021
3022 /**
3023 * Used with {@link #ACTION_MAIN} to launch the maps application.
3024 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003025 * <p>NOTE: This should not be used as the primary key of an Intent,
3026 * since it will not result in the app launching with the correct
3027 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003028 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003029 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003030 */
3031 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3032 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3033
3034 /**
3035 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3036 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003037 * <p>NOTE: This should not be used as the primary key of an Intent,
3038 * since it will not result in the app launching with the correct
3039 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003040 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003041 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003042 */
3043 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3044 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3045
3046 /**
3047 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003048 * The activity should be able to play, browse, or manipulate music files
3049 * stored on the device.
3050 * <p>NOTE: This should not be used as the primary key of an Intent,
3051 * since it will not result in the app launching with the correct
3052 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003053 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003054 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003055 */
3056 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3057 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3058
3059 // ---------------------------------------------------------------------
3060 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003061 // Standard extra data keys.
3062
3063 /**
3064 * The initial data to place in a newly created record. Use with
3065 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3066 * fields as would be given to the underlying ContentProvider.insert()
3067 * call.
3068 */
3069 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3070
3071 /**
3072 * A constant CharSequence that is associated with the Intent, used with
3073 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3074 * this may be a styled CharSequence, so you must use
3075 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3076 * retrieve it.
3077 */
3078 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3079
3080 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003081 * A constant String that is associated with the Intent, used with
3082 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3083 * as HTML formatted text. Note that you <em>must</em> also supply
3084 * {@link #EXTRA_TEXT}.
3085 */
3086 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3087
3088 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003089 * A content: URI holding a stream of data associated with the Intent,
3090 * used with {@link #ACTION_SEND} to supply the data being sent.
3091 */
3092 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3093
3094 /**
3095 * A String[] holding e-mail addresses that should be delivered to.
3096 */
3097 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3098
3099 /**
3100 * A String[] holding e-mail addresses that should be carbon copied.
3101 */
3102 public static final String EXTRA_CC = "android.intent.extra.CC";
3103
3104 /**
3105 * A String[] holding e-mail addresses that should be blind carbon copied.
3106 */
3107 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3108
3109 /**
3110 * A constant string holding the desired subject line of a message.
3111 */
3112 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3113
3114 /**
3115 * An Intent describing the choices you would like shown with
3116 * {@link #ACTION_PICK_ACTIVITY}.
3117 */
3118 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3119
3120 /**
3121 * A CharSequence dialog title to provide to the user when used with a
3122 * {@link #ACTION_CHOOSER}.
3123 */
3124 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3125
3126 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003127 * A Parcelable[] of {@link Intent} or
3128 * {@link android.content.pm.LabeledIntent} objects as set with
3129 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3130 * a the front of the list of choices, when shown to the user with a
3131 * {@link #ACTION_CHOOSER}.
3132 */
3133 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3134
3135 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003136 * A {@link android.view.KeyEvent} object containing the event that
3137 * triggered the creation of the Intent it is in.
3138 */
3139 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3140
3141 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003142 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3143 * before shutting down.
3144 *
3145 * {@hide}
3146 */
3147 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3148
3149 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003150 * 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 -07003151 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3152 * of restarting the application.
3153 */
3154 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3155
3156 /**
3157 * A String holding the phone number originally entered in
3158 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3159 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3160 */
3161 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003162
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003163 /**
3164 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3165 * intents to supply the uid the package had been assigned. Also an optional
3166 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3167 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3168 * purpose.
3169 */
3170 public static final String EXTRA_UID = "android.intent.extra.UID";
3171
3172 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003173 * @hide String array of package names.
3174 */
3175 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3176
3177 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003178 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3179 * intents to indicate whether this represents a full uninstall (removing
3180 * both the code and its data) or a partial uninstall (leaving its data,
3181 * implying that this is an update).
3182 */
3183 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003184
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003185 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003186 * @hide
3187 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3188 * intents to indicate that at this point the package has been removed for
3189 * all users on the device.
3190 */
3191 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3192 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3193
3194 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003195 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3196 * intents to indicate that this is a replacement of the package, so this
3197 * broadcast will immediately be followed by an add broadcast for a
3198 * different version of the same package.
3199 */
3200 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003201
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003202 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003203 * Used as an int extra field in {@link android.app.AlarmManager} intents
3204 * to tell the application being invoked how many pending alarms are being
3205 * delievered with the intent. For one-shot alarms this will always be 1.
3206 * For recurring alarms, this might be greater than 1 if the device was
3207 * asleep or powered off at the time an earlier alarm would have been
3208 * delivered.
3209 */
3210 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003211
Jacek Surazski86b6c532009-05-13 14:38:28 +02003212 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003213 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3214 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003215 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3216 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003217 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3218 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3219 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003220 */
3221 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3222
3223 /**
3224 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3225 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003226 */
3227 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3228
3229 /**
3230 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3231 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003232 */
3233 public static final int EXTRA_DOCK_STATE_DESK = 1;
3234
3235 /**
3236 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3237 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003238 */
3239 public static final int EXTRA_DOCK_STATE_CAR = 2;
3240
3241 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003242 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3243 * to represent that the phone is in a analog (low end) dock.
3244 */
3245 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3246
3247 /**
3248 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3249 * to represent that the phone is in a digital (high end) dock.
3250 */
3251 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3252
3253 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003254 * Boolean that can be supplied as meta-data with a dock activity, to
3255 * indicate that the dock should take over the home key when it is active.
3256 */
3257 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003258
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003259 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003260 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3261 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003262 */
3263 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3264
3265 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003266 * Used in the extra field in the remote intent. It's astring token passed with the
3267 * remote intent.
3268 */
3269 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3270 "android.intent.extra.remote_intent_token";
3271
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003272 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003273 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003274 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003275 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003276 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003277 "android.intent.extra.changed_component_name";
3278
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003279 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003280 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003281 * and contains a string array of all of the components that have changed. If
3282 * the state of the overall package has changed, then it will contain an entry
3283 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003284 */
3285 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3286 "android.intent.extra.changed_component_name_list";
3287
3288 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003289 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003290 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3291 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003292 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003293 */
3294 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3295 "android.intent.extra.changed_package_list";
3296
3297 /**
3298 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003299 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3300 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003301 * and contains an integer array of uids of all of the components
3302 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003303 */
3304 public static final String EXTRA_CHANGED_UID_LIST =
3305 "android.intent.extra.changed_uid_list";
3306
3307 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003308 * @hide
3309 * Magic extra system code can use when binding, to give a label for
3310 * who it is that has bound to a service. This is an integer giving
3311 * a framework string resource that can be displayed to the user.
3312 */
3313 public static final String EXTRA_CLIENT_LABEL =
3314 "android.intent.extra.client_label";
3315
3316 /**
3317 * @hide
3318 * Magic extra system code can use when binding, to give a PendingIntent object
3319 * that can be launched for the user to disable the system's use of this
3320 * service.
3321 */
3322 public static final String EXTRA_CLIENT_INTENT =
3323 "android.intent.extra.client_intent";
3324
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003325 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003326 * Extra used to indicate that an intent should only return data that is on
3327 * the local device. This is a boolean extra; the default is false. If true,
3328 * an implementation should only allow the user to select data that is
3329 * already on the device, not requiring it be downloaded from a remote
3330 * service when opened.
3331 *
3332 * @see #ACTION_GET_CONTENT
3333 * @see #ACTION_OPEN_DOCUMENT
3334 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003335 */
3336 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003337 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003338
Amith Yamasani13593602012-03-22 16:16:17 -07003339 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003340 * Extra used to indicate that an intent can allow the user to select and
3341 * return multiple items. This is a boolean extra; the default is false. If
3342 * true, an implementation is allowed to present the user with a UI where
3343 * they can pick multiple items that are all returned to the caller. When
3344 * this happens, they should be returned as the {@link #getClipData()} part
3345 * of the result Intent.
3346 *
3347 * @see #ACTION_GET_CONTENT
3348 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003349 */
3350 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003351 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003352
3353 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003354 * The integer userHandle carried with broadcast intents related to addition, removal and
3355 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3356 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3357 *
Amith Yamasani13593602012-03-22 16:16:17 -07003358 * @hide
3359 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003360 public static final String EXTRA_USER_HANDLE =
3361 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003362
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003363 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003364 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3365 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3366 */
3367 public static final String EXTRA_USER =
3368 "android.intent.extra.user";
3369
3370 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003371 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003372 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3373 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003374 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003375 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3376
3377 /**
3378 * Extra sent in the intent to the BroadcastReceiver that handles
3379 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3380 * the restrictions as key/value pairs.
3381 */
3382 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3383 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003384
Amith Yamasani86118ba2013-03-28 14:33:16 -07003385 /**
3386 * Extra used in the response from a BroadcastReceiver that handles
3387 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3388 */
3389 public static final String EXTRA_RESTRICTIONS_INTENT =
3390 "android.intent.extra.restrictions_intent";
3391
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003392 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003393 * Extra used to communicate a set of acceptable MIME types. The type of the
3394 * extra is {@code String[]}. Values may be a combination of concrete MIME
3395 * types (such as "image/png") and/or partial MIME types (such as
3396 * "audio/*").
3397 *
3398 * @see #ACTION_GET_CONTENT
3399 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003400 */
3401 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3402
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003403 /**
3404 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3405 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003406 * When this is true, hardware devices can use this information to determine that
3407 * they shouldn't do a complete shutdown of their device since this is not a
3408 * complete shutdown down to the kernel, but only user space restarting.
3409 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003410 */
3411 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3412 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3413
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003414 /**
3415 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3416 * user has set their time format preferences to the 24 hour format.
3417 *
3418 * @hide for internal use only.
3419 */
3420 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3421 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003423 // ---------------------------------------------------------------------
3424 // ---------------------------------------------------------------------
3425 // Intent flags (see mFlags variable).
3426
Tor Norbyed9273d62013-05-30 15:59:53 -07003427 /** @hide */
3428 @IntDef(flag = true,
3429 value = {FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION})
3430 @Retention(RetentionPolicy.SOURCE)
3431 public @interface GrantUriMode {}
3432
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003433 /**
3434 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003435 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003436 * specified in its ClipData. When applying to an Intent's ClipData,
3437 * all URIs as well as recursive traversals through data or other ClipData
3438 * in Intent items will be granted; only the grant flags of the top-level
3439 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003440 */
3441 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3442 /**
3443 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003444 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003445 * specified in its ClipData. When applying to an Intent's ClipData,
3446 * all URIs as well as recursive traversals through data or other ClipData
3447 * in Intent items will be granted; only the grant flags of the top-level
3448 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003449 */
3450 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3451 /**
3452 * Can be set by the caller to indicate that this Intent is coming from
3453 * a background operation, not from direct user interaction.
3454 */
3455 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3456 /**
3457 * A flag you can enable for debugging: when set, log messages will be
3458 * printed during the resolution of this intent to show you what has
3459 * been found to create the final resolved list.
3460 */
3461 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003462 /**
3463 * If set, this intent will not match any components in packages that
3464 * are currently stopped. If this is not set, then the default behavior
3465 * is to include such applications in the result.
3466 */
3467 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3468 /**
3469 * If set, this intent will always match any components in packages that
3470 * are currently stopped. This is the default behavior when
3471 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3472 * flags are set, this one wins (it allows overriding of exclude for
3473 * places where the framework may automatically set the exclude flag).
3474 */
3475 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003476
3477 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003478 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003479 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003480 * persisted across device reboots until explicitly revoked with
3481 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3482 * grant for possible persisting; the receiving application must call
3483 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3484 * actually persist.
3485 *
3486 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3487 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3488 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003489 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003490 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003491 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003492
3493 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003494 * If set, the new activity is not kept in the history stack. As soon as
3495 * the user navigates away from it, the activity is finished. This may also
3496 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3497 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003498 */
3499 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3500 /**
3501 * If set, the activity will not be launched if it is already running
3502 * at the top of the history stack.
3503 */
3504 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3505 /**
3506 * If set, this activity will become the start of a new task on this
3507 * history stack. A task (from the activity that started it to the
3508 * next task activity) defines an atomic group of activities that the
3509 * user can move to. Tasks can be moved to the foreground and background;
3510 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003511 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003512 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3513 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003514 *
3515 * <p>This flag is generally used by activities that want
3516 * to present a "launcher" style behavior: they give the user a list of
3517 * separate things that can be done, which otherwise run completely
3518 * independently of the activity launching them.
3519 *
3520 * <p>When using this flag, if a task is already running for the activity
3521 * you are now starting, then a new activity will not be started; instead,
3522 * the current task will simply be brought to the front of the screen with
3523 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3524 * to disable this behavior.
3525 *
3526 * <p>This flag can not be used when the caller is requesting a result from
3527 * the activity being launched.
3528 */
3529 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3530 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003531 * This flag is used to create a new task and launch an activity into it.
3532 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3533 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3534 * search through existing tasks for ones matching this Intent. Only if no such
3535 * task is found would a new task be created. When paired with
3536 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3537 * the search for a matching task and unconditionally start a new task.
3538 *
3539 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3540 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003541 * top-level application launcher.</strong> Used in conjunction with
3542 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3543 * behavior of bringing an existing task to the foreground. When set,
3544 * a new task is <em>always</em> started to host the Activity for the
3545 * Intent, regardless of whether there is already an existing task running
3546 * the same thing.
3547 *
3548 * <p><strong>Because the default system does not include graphical task management,
3549 * you should not use this flag unless you provide some way for a user to
3550 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003551 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003552 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3553 * creating new document tasks.
3554 *
3555 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3556 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003557 *
Scott Main7aee61f2011-02-08 11:25:01 -08003558 * <p>See
3559 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3560 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003561 *
3562 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3563 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003564 */
3565 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3566 /**
3567 * If set, and the activity being launched is already running in the
3568 * current task, then instead of launching a new instance of that activity,
3569 * all of the other activities on top of it will be closed and this Intent
3570 * will be delivered to the (now on top) old activity as a new Intent.
3571 *
3572 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3573 * If D calls startActivity() with an Intent that resolves to the component
3574 * of activity B, then C and D will be finished and B receive the given
3575 * Intent, resulting in the stack now being: A, B.
3576 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003577 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003578 * either receive the new intent you are starting here in its
3579 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003580 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003581 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3582 * the same intent, then it will be finished and re-created; for all other
3583 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3584 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003585 *
3586 * <p>This launch mode can also be used to good effect in conjunction with
3587 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3588 * of a task, it will bring any currently running instance of that task
3589 * to the foreground, and then clear it to its root state. This is
3590 * especially useful, for example, when launching an activity from the
3591 * notification manager.
3592 *
Scott Main7aee61f2011-02-08 11:25:01 -08003593 * <p>See
3594 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3595 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003596 */
3597 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3598 /**
3599 * If set and this intent is being used to launch a new activity from an
3600 * existing one, then the reply target of the existing activity will be
3601 * transfered to the new activity. This way the new activity can call
3602 * {@link android.app.Activity#setResult} and have that result sent back to
3603 * the reply target of the original activity.
3604 */
3605 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3606 /**
3607 * If set and this intent is being used to launch a new activity from an
3608 * existing one, the current activity will not be counted as the top
3609 * activity for deciding whether the new intent should be delivered to
3610 * the top instead of starting a new one. The previous activity will
3611 * be used as the top, with the assumption being that the current activity
3612 * will finish itself immediately.
3613 */
3614 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3615 /**
3616 * If set, the new activity is not kept in the list of recently launched
3617 * activities.
3618 */
3619 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3620 /**
3621 * This flag is not normally set by application code, but set for you by
3622 * the system as described in the
3623 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3624 * launchMode} documentation for the singleTask mode.
3625 */
3626 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3627 /**
3628 * If set, and this activity is either being started in a new task or
3629 * bringing to the top an existing task, then it will be launched as
3630 * the front door of the task. This will result in the application of
3631 * any affinities needed to have that task in the proper state (either
3632 * moving activities to or from it), or simply resetting that task to
3633 * its initial state if needed.
3634 */
3635 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3636 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003637 * This flag is not normally set by application code, but set for you by
3638 * the system if this activity is being launched from history
3639 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003640 */
3641 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003642 /**
3643 * If set, this marks a point in the task's activity stack that should
3644 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003645 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003646 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3647 * the user re-launching it from home), this activity and all on top of
3648 * it will be finished so that the user does not return to them, but
3649 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003650 *
Craig Mautnere1f3fa22014-01-24 18:02:10 -08003651 * <p>When this flag is assigned to the root activity all activities up
3652 * to, but not including the root activity, will be cleared. This prevents
3653 * this flag from being used to finish all activities in a task and thereby
3654 * ending the task.
3655 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003656 * <p>This is useful for cases where you have a logical break in your
3657 * application. For example, an e-mail application may have a command
3658 * to view an attachment, which launches an image view activity to
3659 * display it. This activity should be part of the e-mail application's
3660 * task, since it is a part of the task the user is involved in. However,
3661 * if the user leaves that task, and later selects the e-mail app from
3662 * home, we may like them to return to the conversation they were
3663 * viewing, not the picture attachment, since that is confusing. By
3664 * setting this flag when launching the image viewer, that viewer and
3665 * any activities it starts will be removed the next time the user returns
3666 * to mail.
3667 */
3668 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003669 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003670 * This flag is used to break out "documents" into separate tasks that can
3671 * be reached via the Recents mechanism. Such a document is any kind of
3672 * item for which an application may want to maintain multiple simultaneous
3673 * instances. Examples might be text files, web pages, spreadsheets, or
3674 * emails. Each such document will be in a separate task in the Recents list.
3675 *
3676 * <p>When set, the activity specified by this Intent will launch into a
3677 * separate task rooted at that activity. The activity launched must be
3678 * defined with {@link android.R.attr#launchMode} "standard" or "singleTop".
3679 *
3680 * <p>If FLAG_ACTIVITY_NEW_DOCUMENT is used without
3681 * {@link #FLAG_ACTIVITY_MULTIPLE_TASK} then the activity manager will
3682 * search for an existing task with a matching target activity and Intent
3683 * data URI and relaunch that task, first finishing all activities down to
3684 * the root activity and then calling the root activity's
3685 * {@link android.app.Activity#onNewIntent(Intent)} method. If no existing
3686 * task's root activity matches the Intent's data URI then a new task will
3687 * be launched with the target activity as root.
3688 *
3689 * <p>When paired with {@link #FLAG_ACTIVITY_MULTIPLE_TASK} this will
3690 * always create a new task. Thus the same document may be made to appear
3691 * more than one time in Recents.
3692 *
3693 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3694 */
3695 public static final int FLAG_ACTIVITY_NEW_DOCUMENT =
3696 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET | FLAG_ACTIVITY_NEW_TASK;
3697 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003698 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003699 * callback from occurring on the current frontmost activity before it is
3700 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003701 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003702 * <p>Typically, an activity can rely on that callback to indicate that an
3703 * explicit user action has caused their activity to be moved out of the
3704 * foreground. The callback marks an appropriate point in the activity's
3705 * lifecycle for it to dismiss any notifications that it intends to display
3706 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003707 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003708 * <p>If an activity is ever started via any non-user-driven events such as
3709 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3710 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003711 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003712 */
3713 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003714 /**
3715 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3716 * this flag will cause the launched activity to be brought to the front of its
3717 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003718 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003719 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3720 * If D calls startActivity() with an Intent that resolves to the component
3721 * of activity B, then B will be brought to the front of the history stack,
3722 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003723 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003724 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003725 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003726 */
3727 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003728 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003729 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3730 * this flag will prevent the system from applying an activity transition
3731 * animation to go to the next activity state. This doesn't mean an
3732 * animation will never run -- if another activity change happens that doesn't
3733 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003734 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003735 * when you are going to do a series of activity operations but the
3736 * animation seen by the user shouldn't be driven by the first activity
3737 * change but rather a later one.
3738 */
3739 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3740 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003741 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3742 * this flag will cause any existing task that would be associated with the
3743 * activity to be cleared before the activity is started. That is, the activity
3744 * becomes the new root of an otherwise empty task, and any old activities
3745 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3746 */
3747 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3748 /**
3749 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3750 * this flag will cause a newly launching task to be placed on top of the current
3751 * home activity task (if there is one). That is, pressing back from the task
3752 * will always return the user to home even if that was not the last activity they
3753 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3754 */
3755 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3756 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003757 * If set, when sending a broadcast only registered receivers will be
3758 * called -- no BroadcastReceiver components will be launched.
3759 */
3760 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003761 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003762 * If set, when sending a broadcast the new broadcast will replace
3763 * any existing pending broadcast that matches it. Matching is defined
3764 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3765 * true for the intents of the two broadcasts. When a match is found,
3766 * the new broadcast (and receivers associated with it) will replace the
3767 * existing one in the pending broadcast list, remaining at the same
3768 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003769 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003770 * <p>This flag is most typically used with sticky broadcasts, which
3771 * only care about delivering the most recent values of the broadcast
3772 * to their receivers.
3773 */
3774 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3775 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003776 * If set, when sending a broadcast the recipient is allowed to run at
3777 * foreground priority, with a shorter timeout interval. During normal
3778 * broadcasts the receivers are not automatically hoisted out of the
3779 * background priority class.
3780 */
3781 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3782 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003783 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3784 * They can still propagate results through to later receivers, but they can not prevent
3785 * later receivers from seeing the broadcast.
3786 */
3787 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3788 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003789 * If set, when sending a broadcast <i>before boot has completed</i> only
3790 * registered receivers will be called -- no BroadcastReceiver components
3791 * will be launched. Sticky intent state will be recorded properly even
3792 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3793 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003794 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003795 * <p>This flag is only for use by system sevices as a convenience to
3796 * avoid having to implement a more complex mechanism around detection
3797 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003798 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003799 * @hide
3800 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003801 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003802 /**
3803 * Set when this broadcast is for a boot upgrade, a special mode that
3804 * allows the broadcast to be sent before the system is ready and launches
3805 * the app process with no providers running in it.
3806 * @hide
3807 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003808 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003809
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003810 /**
3811 * @hide Flags that can't be changed with PendingIntent.
3812 */
3813 public static final int IMMUTABLE_FLAGS =
3814 FLAG_GRANT_READ_URI_PERMISSION
3815 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003816
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003817 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003818 // ---------------------------------------------------------------------
3819 // toUri() and parseUri() options.
3820
3821 /**
3822 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3823 * always has the "intent:" scheme. This syntax can be used when you want
3824 * to later disambiguate between URIs that are intended to describe an
3825 * Intent vs. all others that should be treated as raw URIs. When used
3826 * with {@link #parseUri}, any other scheme will result in a generic
3827 * VIEW action for that raw URI.
3828 */
3829 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003830
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003831 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003832
3833 private String mAction;
3834 private Uri mData;
3835 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003836 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003837 private ComponentName mComponent;
3838 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003839 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003841 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003842 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003843 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003844
3845 // ---------------------------------------------------------------------
3846
3847 /**
3848 * Create an empty intent.
3849 */
3850 public Intent() {
3851 }
3852
3853 /**
3854 * Copy constructor.
3855 */
3856 public Intent(Intent o) {
3857 this.mAction = o.mAction;
3858 this.mData = o.mData;
3859 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003860 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003861 this.mComponent = o.mComponent;
3862 this.mFlags = o.mFlags;
3863 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003864 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003865 }
3866 if (o.mExtras != null) {
3867 this.mExtras = new Bundle(o.mExtras);
3868 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003869 if (o.mSourceBounds != null) {
3870 this.mSourceBounds = new Rect(o.mSourceBounds);
3871 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003872 if (o.mSelector != null) {
3873 this.mSelector = new Intent(o.mSelector);
3874 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003875 if (o.mClipData != null) {
3876 this.mClipData = new ClipData(o.mClipData);
3877 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003878 }
3879
3880 @Override
3881 public Object clone() {
3882 return new Intent(this);
3883 }
3884
3885 private Intent(Intent o, boolean all) {
3886 this.mAction = o.mAction;
3887 this.mData = o.mData;
3888 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003889 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003890 this.mComponent = o.mComponent;
3891 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003892 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003893 }
3894 }
3895
3896 /**
3897 * Make a clone of only the parts of the Intent that are relevant for
3898 * filter matching: the action, data, type, component, and categories.
3899 */
3900 public Intent cloneFilter() {
3901 return new Intent(this, false);
3902 }
3903
3904 /**
3905 * Create an intent with a given action. All other fields (data, type,
3906 * class) are null. Note that the action <em>must</em> be in a
3907 * namespace because Intents are used globally in the system -- for
3908 * example the system VIEW action is android.intent.action.VIEW; an
3909 * application's custom action would be something like
3910 * com.google.app.myapp.CUSTOM_ACTION.
3911 *
3912 * @param action The Intent action, such as ACTION_VIEW.
3913 */
3914 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003915 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003916 }
3917
3918 /**
3919 * Create an intent with a given action and for a given data url. Note
3920 * that the action <em>must</em> be in a namespace because Intents are
3921 * used globally in the system -- for example the system VIEW action is
3922 * android.intent.action.VIEW; an application's custom action would be
3923 * something like com.google.app.myapp.CUSTOM_ACTION.
3924 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003925 * <p><em>Note: scheme and host name matching in the Android framework is
3926 * case-sensitive, unlike the formal RFC. As a result,
3927 * you should always ensure that you write your Uri with these elements
3928 * using lower case letters, and normalize any Uris you receive from
3929 * outside of Android to ensure the scheme and host is lower case.</em></p>
3930 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003931 * @param action The Intent action, such as ACTION_VIEW.
3932 * @param uri The Intent data URI.
3933 */
3934 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003935 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003936 mData = uri;
3937 }
3938
3939 /**
3940 * Create an intent for a specific component. All other fields (action, data,
3941 * type, class) are null, though they can be modified later with explicit
3942 * calls. This provides a convenient way to create an intent that is
3943 * intended to execute a hard-coded class name, rather than relying on the
3944 * system to find an appropriate class for you; see {@link #setComponent}
3945 * for more information on the repercussions of this.
3946 *
3947 * @param packageContext A Context of the application package implementing
3948 * this class.
3949 * @param cls The component class that is to be used for the intent.
3950 *
3951 * @see #setClass
3952 * @see #setComponent
3953 * @see #Intent(String, android.net.Uri , Context, Class)
3954 */
3955 public Intent(Context packageContext, Class<?> cls) {
3956 mComponent = new ComponentName(packageContext, cls);
3957 }
3958
3959 /**
3960 * Create an intent for a specific component with a specified action and data.
3961 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3962 * construct the Intent and then calling {@link #setClass} to set its
3963 * class.
3964 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003965 * <p><em>Note: scheme and host name matching in the Android framework is
3966 * case-sensitive, unlike the formal RFC. As a result,
3967 * you should always ensure that you write your Uri with these elements
3968 * using lower case letters, and normalize any Uris you receive from
3969 * outside of Android to ensure the scheme and host is lower case.</em></p>
3970 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003971 * @param action The Intent action, such as ACTION_VIEW.
3972 * @param uri The Intent data URI.
3973 * @param packageContext A Context of the application package implementing
3974 * this class.
3975 * @param cls The component class that is to be used for the intent.
3976 *
3977 * @see #Intent(String, android.net.Uri)
3978 * @see #Intent(Context, Class)
3979 * @see #setClass
3980 * @see #setComponent
3981 */
3982 public Intent(String action, Uri uri,
3983 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003984 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003985 mData = uri;
3986 mComponent = new ComponentName(packageContext, cls);
3987 }
3988
3989 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003990 * Create an intent to launch the main (root) activity of a task. This
3991 * is the Intent that is started when the application's is launched from
3992 * Home. For anything else that wants to launch an application in the
3993 * same way, it is important that they use an Intent structured the same
3994 * way, and can use this function to ensure this is the case.
3995 *
3996 * <p>The returned Intent has the given Activity component as its explicit
3997 * component, {@link #ACTION_MAIN} as its action, and includes the
3998 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3999 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4000 * to do that through {@link #addFlags(int)} on the returned Intent.
4001 *
4002 * @param mainActivity The main activity component that this Intent will
4003 * launch.
4004 * @return Returns a newly created Intent that can be used to launch the
4005 * activity as a main application entry.
4006 *
4007 * @see #setClass
4008 * @see #setComponent
4009 */
4010 public static Intent makeMainActivity(ComponentName mainActivity) {
4011 Intent intent = new Intent(ACTION_MAIN);
4012 intent.setComponent(mainActivity);
4013 intent.addCategory(CATEGORY_LAUNCHER);
4014 return intent;
4015 }
4016
4017 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004018 * Make an Intent for the main activity of an application, without
4019 * specifying a specific activity to run but giving a selector to find
4020 * the activity. This results in a final Intent that is structured
4021 * the same as when the application is launched from
4022 * Home. For anything else that wants to launch an application in the
4023 * same way, it is important that they use an Intent structured the same
4024 * way, and can use this function to ensure this is the case.
4025 *
4026 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4027 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4028 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4029 * to do that through {@link #addFlags(int)} on the returned Intent.
4030 *
4031 * @param selectorAction The action name of the Intent's selector.
4032 * @param selectorCategory The name of a category to add to the Intent's
4033 * selector.
4034 * @return Returns a newly created Intent that can be used to launch the
4035 * activity as a main application entry.
4036 *
4037 * @see #setSelector(Intent)
4038 */
4039 public static Intent makeMainSelectorActivity(String selectorAction,
4040 String selectorCategory) {
4041 Intent intent = new Intent(ACTION_MAIN);
4042 intent.addCategory(CATEGORY_LAUNCHER);
4043 Intent selector = new Intent();
4044 selector.setAction(selectorAction);
4045 selector.addCategory(selectorCategory);
4046 intent.setSelector(selector);
4047 return intent;
4048 }
4049
4050 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004051 * Make an Intent that can be used to re-launch an application's task
4052 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4053 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4054 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4055 *
4056 * @param mainActivity The activity component that is the root of the
4057 * task; this is the activity that has been published in the application's
4058 * manifest as the main launcher icon.
4059 *
4060 * @return Returns a newly created Intent that can be used to relaunch the
4061 * activity's task in its root state.
4062 */
4063 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4064 Intent intent = makeMainActivity(mainActivity);
4065 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4066 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4067 return intent;
4068 }
4069
4070 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004071 * Call {@link #parseUri} with 0 flags.
4072 * @deprecated Use {@link #parseUri} instead.
4073 */
4074 @Deprecated
4075 public static Intent getIntent(String uri) throws URISyntaxException {
4076 return parseUri(uri, 0);
4077 }
Tom Taylord4a47292009-12-21 13:59:18 -08004078
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004080 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004081 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004082 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004083 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004084 *
4085 * <p>The URI given here must not be relative -- that is, it must include
4086 * the scheme and full path.
4087 *
4088 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004089 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004090 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004091 *
4092 * @return Intent The newly created Intent object.
4093 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004094 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4095 * it bad (as parsed by the Uri class) or the Intent data within the
4096 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004097 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004098 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004099 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004100 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004101 int i = 0;
4102 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004103 // Validate intent scheme for if requested.
4104 if ((flags&URI_INTENT_SCHEME) != 0) {
4105 if (!uri.startsWith("intent:")) {
4106 Intent intent = new Intent(ACTION_VIEW);
4107 try {
4108 intent.setData(Uri.parse(uri));
4109 } catch (IllegalArgumentException e) {
4110 throw new URISyntaxException(uri, e.getMessage());
4111 }
4112 return intent;
4113 }
4114 }
Tom Taylord4a47292009-12-21 13:59:18 -08004115
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004116 // simple case
4117 i = uri.lastIndexOf("#");
4118 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4119
4120 // old format Intent URI
4121 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004122
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004123 // new format
4124 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004125 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004126
4127 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004128 String data = i >= 0 ? uri.substring(0, i) : null;
4129 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004130 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004131
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004132 // loop over contents of Intent, all name=value;
4133 while (!uri.startsWith("end", i)) {
4134 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004135 if (eq < 0) eq = i-1;
4136 int semi = uri.indexOf(';', i);
4137 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004138
4139 // action
4140 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004141 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004142 }
4143
4144 // categories
4145 else if (uri.startsWith("category=", i)) {
4146 intent.addCategory(value);
4147 }
4148
4149 // type
4150 else if (uri.startsWith("type=", i)) {
4151 intent.mType = value;
4152 }
4153
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004154 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004155 else if (uri.startsWith("launchFlags=", i)) {
4156 intent.mFlags = Integer.decode(value).intValue();
4157 }
4158
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004159 // package
4160 else if (uri.startsWith("package=", i)) {
4161 intent.mPackage = value;
4162 }
4163
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004164 // component
4165 else if (uri.startsWith("component=", i)) {
4166 intent.mComponent = ComponentName.unflattenFromString(value);
4167 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004168
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004169 // scheme
4170 else if (uri.startsWith("scheme=", i)) {
4171 scheme = value;
4172 }
4173
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004174 // source bounds
4175 else if (uri.startsWith("sourceBounds=", i)) {
4176 intent.mSourceBounds = Rect.unflattenFromString(value);
4177 }
4178
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004179 // selector
4180 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4181 intent = new Intent();
4182 }
4183
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004184 // extra
4185 else {
4186 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004187 // create Bundle if it doesn't already exist
4188 if (intent.mExtras == null) intent.mExtras = new Bundle();
4189 Bundle b = intent.mExtras;
4190 // add EXTRA
4191 if (uri.startsWith("S.", i)) b.putString(key, value);
4192 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4193 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4194 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4195 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4196 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4197 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4198 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4199 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4200 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4201 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004202
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004203 // move to the next item
4204 i = semi + 1;
4205 }
4206
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004207 if (intent != baseIntent) {
4208 // The Intent had a selector; fix it up.
4209 baseIntent.setSelector(intent);
4210 intent = baseIntent;
4211 }
4212
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004213 if (data != null) {
4214 if (data.startsWith("intent:")) {
4215 data = data.substring(7);
4216 if (scheme != null) {
4217 data = scheme + ':' + data;
4218 }
4219 }
Tom Taylord4a47292009-12-21 13:59:18 -08004220
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004221 if (data.length() > 0) {
4222 try {
4223 intent.mData = Uri.parse(data);
4224 } catch (IllegalArgumentException e) {
4225 throw new URISyntaxException(uri, e.getMessage());
4226 }
4227 }
4228 }
Tom Taylord4a47292009-12-21 13:59:18 -08004229
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004230 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004231
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004232 } catch (IndexOutOfBoundsException e) {
4233 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4234 }
4235 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004236
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004237 public static Intent getIntentOld(String uri) throws URISyntaxException {
4238 Intent intent;
4239
4240 int i = uri.lastIndexOf('#');
4241 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004242 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004243 final int intentFragmentStart = i;
4244 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004245
4246 i++;
4247
4248 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004249 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004250 i += 7;
4251 int j = uri.indexOf(')', i);
4252 action = uri.substring(i, j);
4253 i = j + 1;
4254 }
4255
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004256 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004257
4258 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004259 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004260 i += 11;
4261 int j = uri.indexOf(')', i);
4262 while (i < j) {
4263 int sep = uri.indexOf('!', i);
4264 if (sep < 0) sep = j;
4265 if (i < sep) {
4266 intent.addCategory(uri.substring(i, sep));
4267 }
4268 i = sep + 1;
4269 }
4270 i = j + 1;
4271 }
4272
4273 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004274 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004275 i += 5;
4276 int j = uri.indexOf(')', i);
4277 intent.mType = uri.substring(i, j);
4278 i = j + 1;
4279 }
4280
4281 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004282 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004283 i += 12;
4284 int j = uri.indexOf(')', i);
4285 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4286 i = j + 1;
4287 }
4288
4289 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004290 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004291 i += 10;
4292 int j = uri.indexOf(')', i);
4293 int sep = uri.indexOf('!', i);
4294 if (sep >= 0 && sep < j) {
4295 String pkg = uri.substring(i, sep);
4296 String cls = uri.substring(sep + 1, j);
4297 intent.mComponent = new ComponentName(pkg, cls);
4298 }
4299 i = j + 1;
4300 }
4301
4302 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004303 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004304 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004305
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004306 final int closeParen = uri.indexOf(')', i);
4307 if (closeParen == -1) throw new URISyntaxException(uri,
4308 "EXTRA missing trailing ')'", i);
4309
4310 while (i < closeParen) {
4311 // fetch the key value
4312 int j = uri.indexOf('=', i);
4313 if (j <= i + 1 || i >= closeParen) {
4314 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4315 }
4316 char type = uri.charAt(i);
4317 i++;
4318 String key = uri.substring(i, j);
4319 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004320
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004321 // get type-value
4322 j = uri.indexOf('!', i);
4323 if (j == -1 || j >= closeParen) j = closeParen;
4324 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4325 String value = uri.substring(i, j);
4326 i = j;
4327
4328 // create Bundle if it doesn't already exist
4329 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004330
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004331 // add item to bundle
4332 try {
4333 switch (type) {
4334 case 'S':
4335 intent.mExtras.putString(key, Uri.decode(value));
4336 break;
4337 case 'B':
4338 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4339 break;
4340 case 'b':
4341 intent.mExtras.putByte(key, Byte.parseByte(value));
4342 break;
4343 case 'c':
4344 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4345 break;
4346 case 'd':
4347 intent.mExtras.putDouble(key, Double.parseDouble(value));
4348 break;
4349 case 'f':
4350 intent.mExtras.putFloat(key, Float.parseFloat(value));
4351 break;
4352 case 'i':
4353 intent.mExtras.putInt(key, Integer.parseInt(value));
4354 break;
4355 case 'l':
4356 intent.mExtras.putLong(key, Long.parseLong(value));
4357 break;
4358 case 's':
4359 intent.mExtras.putShort(key, Short.parseShort(value));
4360 break;
4361 default:
4362 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4363 }
4364 } catch (NumberFormatException e) {
4365 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4366 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004367
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004368 char ch = uri.charAt(i);
4369 if (ch == ')') break;
4370 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4371 i++;
4372 }
4373 }
4374
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004375 if (isIntentFragment) {
4376 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4377 } else {
4378 intent.mData = Uri.parse(uri);
4379 }
Tom Taylord4a47292009-12-21 13:59:18 -08004380
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004381 if (intent.mAction == null) {
4382 // By default, if no action is specified, then use VIEW.
4383 intent.mAction = ACTION_VIEW;
4384 }
4385
4386 } else {
4387 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4388 }
4389
4390 return intent;
4391 }
4392
4393 /**
4394 * Retrieve the general action to be performed, such as
4395 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4396 * the information in the intent should be interpreted -- most importantly,
4397 * what to do with the data returned by {@link #getData}.
4398 *
4399 * @return The action of this intent or null if none is specified.
4400 *
4401 * @see #setAction
4402 */
4403 public String getAction() {
4404 return mAction;
4405 }
4406
4407 /**
4408 * Retrieve data this intent is operating on. This URI specifies the name
4409 * of the data; often it uses the content: scheme, specifying data in a
4410 * content provider. Other schemes may be handled by specific activities,
4411 * such as http: by the web browser.
4412 *
4413 * @return The URI of the data this intent is targeting or null.
4414 *
4415 * @see #getScheme
4416 * @see #setData
4417 */
4418 public Uri getData() {
4419 return mData;
4420 }
4421
4422 /**
4423 * The same as {@link #getData()}, but returns the URI as an encoded
4424 * String.
4425 */
4426 public String getDataString() {
4427 return mData != null ? mData.toString() : null;
4428 }
4429
4430 /**
4431 * Return the scheme portion of the intent's data. If the data is null or
4432 * does not include a scheme, null is returned. Otherwise, the scheme
4433 * prefix without the final ':' is returned, i.e. "http".
4434 *
4435 * <p>This is the same as calling getData().getScheme() (and checking for
4436 * null data).
4437 *
4438 * @return The scheme of this intent.
4439 *
4440 * @see #getData
4441 */
4442 public String getScheme() {
4443 return mData != null ? mData.getScheme() : null;
4444 }
4445
4446 /**
4447 * Retrieve any explicit MIME type included in the intent. This is usually
4448 * null, as the type is determined by the intent data.
4449 *
4450 * @return If a type was manually set, it is returned; else null is
4451 * returned.
4452 *
4453 * @see #resolveType(ContentResolver)
4454 * @see #setType
4455 */
4456 public String getType() {
4457 return mType;
4458 }
4459
4460 /**
4461 * Return the MIME data type of this intent. If the type field is
4462 * explicitly set, that is simply returned. Otherwise, if the data is set,
4463 * the type of that data is returned. If neither fields are set, a null is
4464 * returned.
4465 *
4466 * @return The MIME type of this intent.
4467 *
4468 * @see #getType
4469 * @see #resolveType(ContentResolver)
4470 */
4471 public String resolveType(Context context) {
4472 return resolveType(context.getContentResolver());
4473 }
4474
4475 /**
4476 * Return the MIME data type of this intent. If the type field is
4477 * explicitly set, that is simply returned. Otherwise, if the data is set,
4478 * the type of that data is returned. If neither fields are set, a null is
4479 * returned.
4480 *
4481 * @param resolver A ContentResolver that can be used to determine the MIME
4482 * type of the intent's data.
4483 *
4484 * @return The MIME type of this intent.
4485 *
4486 * @see #getType
4487 * @see #resolveType(Context)
4488 */
4489 public String resolveType(ContentResolver resolver) {
4490 if (mType != null) {
4491 return mType;
4492 }
4493 if (mData != null) {
4494 if ("content".equals(mData.getScheme())) {
4495 return resolver.getType(mData);
4496 }
4497 }
4498 return null;
4499 }
4500
4501 /**
4502 * Return the MIME data type of this intent, only if it will be needed for
4503 * intent resolution. This is not generally useful for application code;
4504 * it is used by the frameworks for communicating with back-end system
4505 * services.
4506 *
4507 * @param resolver A ContentResolver that can be used to determine the MIME
4508 * type of the intent's data.
4509 *
4510 * @return The MIME type of this intent, or null if it is unknown or not
4511 * needed.
4512 */
4513 public String resolveTypeIfNeeded(ContentResolver resolver) {
4514 if (mComponent != null) {
4515 return mType;
4516 }
4517 return resolveType(resolver);
4518 }
4519
4520 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004521 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004522 *
4523 * @param category The category to check.
4524 *
4525 * @return boolean True if the intent contains the category, else false.
4526 *
4527 * @see #getCategories
4528 * @see #addCategory
4529 */
4530 public boolean hasCategory(String category) {
4531 return mCategories != null && mCategories.contains(category);
4532 }
4533
4534 /**
4535 * Return the set of all categories in the intent. If there are no categories,
4536 * returns NULL.
4537 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004538 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004539 *
4540 * @see #hasCategory
4541 * @see #addCategory
4542 */
4543 public Set<String> getCategories() {
4544 return mCategories;
4545 }
4546
4547 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004548 * Return the specific selector associated with this Intent. If there is
4549 * none, returns null. See {@link #setSelector} for more information.
4550 *
4551 * @see #setSelector
4552 */
4553 public Intent getSelector() {
4554 return mSelector;
4555 }
4556
4557 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004558 * Return the {@link ClipData} associated with this Intent. If there is
4559 * none, returns null. See {@link #setClipData} for more information.
4560 *
John Spurlock125d1332013-11-25 11:58:37 -05004561 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004562 */
4563 public ClipData getClipData() {
4564 return mClipData;
4565 }
4566
4567 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004568 * Sets the ClassLoader that will be used when unmarshalling
4569 * any Parcelable values from the extras of this Intent.
4570 *
4571 * @param loader a ClassLoader, or null to use the default loader
4572 * at the time of unmarshalling.
4573 */
4574 public void setExtrasClassLoader(ClassLoader loader) {
4575 if (mExtras != null) {
4576 mExtras.setClassLoader(loader);
4577 }
4578 }
4579
4580 /**
4581 * Returns true if an extra value is associated with the given name.
4582 * @param name the extra's name
4583 * @return true if the given extra is present.
4584 */
4585 public boolean hasExtra(String name) {
4586 return mExtras != null && mExtras.containsKey(name);
4587 }
4588
4589 /**
4590 * Returns true if the Intent's extras contain a parcelled file descriptor.
4591 * @return true if the Intent contains a parcelled file descriptor.
4592 */
4593 public boolean hasFileDescriptors() {
4594 return mExtras != null && mExtras.hasFileDescriptors();
4595 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004596
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004597 /** @hide */
4598 public void setAllowFds(boolean allowFds) {
4599 if (mExtras != null) {
4600 mExtras.setAllowFds(allowFds);
4601 }
4602 }
4603
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004604 /**
4605 * Retrieve extended data from the intent.
4606 *
4607 * @param name The name of the desired item.
4608 *
4609 * @return the value of an item that previously added with putExtra()
4610 * or null if none was found.
4611 *
4612 * @deprecated
4613 * @hide
4614 */
4615 @Deprecated
4616 public Object getExtra(String name) {
4617 return getExtra(name, null);
4618 }
4619
4620 /**
4621 * Retrieve extended data from the intent.
4622 *
4623 * @param name The name of the desired item.
4624 * @param defaultValue the value to be returned if no value of the desired
4625 * type is stored with the given name.
4626 *
4627 * @return the value of an item that previously added with putExtra()
4628 * or the default value if none was found.
4629 *
4630 * @see #putExtra(String, boolean)
4631 */
4632 public boolean getBooleanExtra(String name, boolean defaultValue) {
4633 return mExtras == null ? defaultValue :
4634 mExtras.getBoolean(name, defaultValue);
4635 }
4636
4637 /**
4638 * Retrieve extended data from the intent.
4639 *
4640 * @param name The name of the desired item.
4641 * @param defaultValue the value to be returned if no value of the desired
4642 * type is stored with the given name.
4643 *
4644 * @return the value of an item that previously added with putExtra()
4645 * or the default value if none was found.
4646 *
4647 * @see #putExtra(String, byte)
4648 */
4649 public byte getByteExtra(String name, byte defaultValue) {
4650 return mExtras == null ? defaultValue :
4651 mExtras.getByte(name, defaultValue);
4652 }
4653
4654 /**
4655 * Retrieve extended data from the intent.
4656 *
4657 * @param name The name of the desired item.
4658 * @param defaultValue the value to be returned if no value of the desired
4659 * type is stored with the given name.
4660 *
4661 * @return the value of an item that previously added with putExtra()
4662 * or the default value if none was found.
4663 *
4664 * @see #putExtra(String, short)
4665 */
4666 public short getShortExtra(String name, short defaultValue) {
4667 return mExtras == null ? defaultValue :
4668 mExtras.getShort(name, defaultValue);
4669 }
4670
4671 /**
4672 * Retrieve extended data from the intent.
4673 *
4674 * @param name The name of the desired item.
4675 * @param defaultValue the value to be returned if no value of the desired
4676 * type is stored with the given name.
4677 *
4678 * @return the value of an item that previously added with putExtra()
4679 * or the default value if none was found.
4680 *
4681 * @see #putExtra(String, char)
4682 */
4683 public char getCharExtra(String name, char defaultValue) {
4684 return mExtras == null ? defaultValue :
4685 mExtras.getChar(name, defaultValue);
4686 }
4687
4688 /**
4689 * Retrieve extended data from the intent.
4690 *
4691 * @param name The name of the desired item.
4692 * @param defaultValue the value to be returned if no value of the desired
4693 * type is stored with the given name.
4694 *
4695 * @return the value of an item that previously added with putExtra()
4696 * or the default value if none was found.
4697 *
4698 * @see #putExtra(String, int)
4699 */
4700 public int getIntExtra(String name, int defaultValue) {
4701 return mExtras == null ? defaultValue :
4702 mExtras.getInt(name, defaultValue);
4703 }
4704
4705 /**
4706 * Retrieve extended data from the intent.
4707 *
4708 * @param name The name of the desired item.
4709 * @param defaultValue the value to be returned if no value of the desired
4710 * type is stored with the given name.
4711 *
4712 * @return the value of an item that previously added with putExtra()
4713 * or the default value if none was found.
4714 *
4715 * @see #putExtra(String, long)
4716 */
4717 public long getLongExtra(String name, long defaultValue) {
4718 return mExtras == null ? defaultValue :
4719 mExtras.getLong(name, defaultValue);
4720 }
4721
4722 /**
4723 * Retrieve extended data from the intent.
4724 *
4725 * @param name The name of the desired item.
4726 * @param defaultValue the value to be returned if no value of the desired
4727 * type is stored with the given name.
4728 *
4729 * @return the value of an item that previously added with putExtra(),
4730 * or the default value if no such item is present
4731 *
4732 * @see #putExtra(String, float)
4733 */
4734 public float getFloatExtra(String name, float defaultValue) {
4735 return mExtras == null ? defaultValue :
4736 mExtras.getFloat(name, defaultValue);
4737 }
4738
4739 /**
4740 * Retrieve extended data from the intent.
4741 *
4742 * @param name The name of the desired item.
4743 * @param defaultValue the value to be returned if no value of the desired
4744 * type is stored with the given name.
4745 *
4746 * @return the value of an item that previously added with putExtra()
4747 * or the default value if none was found.
4748 *
4749 * @see #putExtra(String, double)
4750 */
4751 public double getDoubleExtra(String name, double defaultValue) {
4752 return mExtras == null ? defaultValue :
4753 mExtras.getDouble(name, defaultValue);
4754 }
4755
4756 /**
4757 * Retrieve extended data from the intent.
4758 *
4759 * @param name The name of the desired item.
4760 *
4761 * @return the value of an item that previously added with putExtra()
4762 * or null if no String value was found.
4763 *
4764 * @see #putExtra(String, String)
4765 */
4766 public String getStringExtra(String name) {
4767 return mExtras == null ? null : mExtras.getString(name);
4768 }
4769
4770 /**
4771 * Retrieve extended data from the intent.
4772 *
4773 * @param name The name of the desired item.
4774 *
4775 * @return the value of an item that previously added with putExtra()
4776 * or null if no CharSequence value was found.
4777 *
4778 * @see #putExtra(String, CharSequence)
4779 */
4780 public CharSequence getCharSequenceExtra(String name) {
4781 return mExtras == null ? null : mExtras.getCharSequence(name);
4782 }
4783
4784 /**
4785 * Retrieve extended data from the intent.
4786 *
4787 * @param name The name of the desired item.
4788 *
4789 * @return the value of an item that previously added with putExtra()
4790 * or null if no Parcelable value was found.
4791 *
4792 * @see #putExtra(String, Parcelable)
4793 */
4794 public <T extends Parcelable> T getParcelableExtra(String name) {
4795 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4796 }
4797
4798 /**
4799 * Retrieve extended data from the intent.
4800 *
4801 * @param name The name of the desired item.
4802 *
4803 * @return the value of an item that previously added with putExtra()
4804 * or null if no Parcelable[] value was found.
4805 *
4806 * @see #putExtra(String, Parcelable[])
4807 */
4808 public Parcelable[] getParcelableArrayExtra(String name) {
4809 return mExtras == null ? null : mExtras.getParcelableArray(name);
4810 }
4811
4812 /**
4813 * Retrieve extended data from the intent.
4814 *
4815 * @param name The name of the desired item.
4816 *
4817 * @return the value of an item that previously added with putExtra()
4818 * or null if no ArrayList<Parcelable> value was found.
4819 *
4820 * @see #putParcelableArrayListExtra(String, ArrayList)
4821 */
4822 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4823 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4824 }
4825
4826 /**
4827 * Retrieve extended data from the intent.
4828 *
4829 * @param name The name of the desired item.
4830 *
4831 * @return the value of an item that previously added with putExtra()
4832 * or null if no Serializable value was found.
4833 *
4834 * @see #putExtra(String, Serializable)
4835 */
4836 public Serializable getSerializableExtra(String name) {
4837 return mExtras == null ? null : mExtras.getSerializable(name);
4838 }
4839
4840 /**
4841 * Retrieve extended data from the intent.
4842 *
4843 * @param name The name of the desired item.
4844 *
4845 * @return the value of an item that previously added with putExtra()
4846 * or null if no ArrayList<Integer> value was found.
4847 *
4848 * @see #putIntegerArrayListExtra(String, ArrayList)
4849 */
4850 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4851 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4852 }
4853
4854 /**
4855 * Retrieve extended data from the intent.
4856 *
4857 * @param name The name of the desired item.
4858 *
4859 * @return the value of an item that previously added with putExtra()
4860 * or null if no ArrayList<String> value was found.
4861 *
4862 * @see #putStringArrayListExtra(String, ArrayList)
4863 */
4864 public ArrayList<String> getStringArrayListExtra(String name) {
4865 return mExtras == null ? null : mExtras.getStringArrayList(name);
4866 }
4867
4868 /**
4869 * Retrieve extended data from the intent.
4870 *
4871 * @param name The name of the desired item.
4872 *
4873 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004874 * or null if no ArrayList<CharSequence> value was found.
4875 *
4876 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4877 */
4878 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4879 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4880 }
4881
4882 /**
4883 * Retrieve extended data from the intent.
4884 *
4885 * @param name The name of the desired item.
4886 *
4887 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004888 * or null if no boolean array value was found.
4889 *
4890 * @see #putExtra(String, boolean[])
4891 */
4892 public boolean[] getBooleanArrayExtra(String name) {
4893 return mExtras == null ? null : mExtras.getBooleanArray(name);
4894 }
4895
4896 /**
4897 * Retrieve extended data from the intent.
4898 *
4899 * @param name The name of the desired item.
4900 *
4901 * @return the value of an item that previously added with putExtra()
4902 * or null if no byte array value was found.
4903 *
4904 * @see #putExtra(String, byte[])
4905 */
4906 public byte[] getByteArrayExtra(String name) {
4907 return mExtras == null ? null : mExtras.getByteArray(name);
4908 }
4909
4910 /**
4911 * Retrieve extended data from the intent.
4912 *
4913 * @param name The name of the desired item.
4914 *
4915 * @return the value of an item that previously added with putExtra()
4916 * or null if no short array value was found.
4917 *
4918 * @see #putExtra(String, short[])
4919 */
4920 public short[] getShortArrayExtra(String name) {
4921 return mExtras == null ? null : mExtras.getShortArray(name);
4922 }
4923
4924 /**
4925 * Retrieve extended data from the intent.
4926 *
4927 * @param name The name of the desired item.
4928 *
4929 * @return the value of an item that previously added with putExtra()
4930 * or null if no char array value was found.
4931 *
4932 * @see #putExtra(String, char[])
4933 */
4934 public char[] getCharArrayExtra(String name) {
4935 return mExtras == null ? null : mExtras.getCharArray(name);
4936 }
4937
4938 /**
4939 * Retrieve extended data from the intent.
4940 *
4941 * @param name The name of the desired item.
4942 *
4943 * @return the value of an item that previously added with putExtra()
4944 * or null if no int array value was found.
4945 *
4946 * @see #putExtra(String, int[])
4947 */
4948 public int[] getIntArrayExtra(String name) {
4949 return mExtras == null ? null : mExtras.getIntArray(name);
4950 }
4951
4952 /**
4953 * Retrieve extended data from the intent.
4954 *
4955 * @param name The name of the desired item.
4956 *
4957 * @return the value of an item that previously added with putExtra()
4958 * or null if no long array value was found.
4959 *
4960 * @see #putExtra(String, long[])
4961 */
4962 public long[] getLongArrayExtra(String name) {
4963 return mExtras == null ? null : mExtras.getLongArray(name);
4964 }
4965
4966 /**
4967 * Retrieve extended data from the intent.
4968 *
4969 * @param name The name of the desired item.
4970 *
4971 * @return the value of an item that previously added with putExtra()
4972 * or null if no float array value was found.
4973 *
4974 * @see #putExtra(String, float[])
4975 */
4976 public float[] getFloatArrayExtra(String name) {
4977 return mExtras == null ? null : mExtras.getFloatArray(name);
4978 }
4979
4980 /**
4981 * Retrieve extended data from the intent.
4982 *
4983 * @param name The name of the desired item.
4984 *
4985 * @return the value of an item that previously added with putExtra()
4986 * or null if no double array value was found.
4987 *
4988 * @see #putExtra(String, double[])
4989 */
4990 public double[] getDoubleArrayExtra(String name) {
4991 return mExtras == null ? null : mExtras.getDoubleArray(name);
4992 }
4993
4994 /**
4995 * Retrieve extended data from the intent.
4996 *
4997 * @param name The name of the desired item.
4998 *
4999 * @return the value of an item that previously added with putExtra()
5000 * or null if no String array value was found.
5001 *
5002 * @see #putExtra(String, String[])
5003 */
5004 public String[] getStringArrayExtra(String name) {
5005 return mExtras == null ? null : mExtras.getStringArray(name);
5006 }
5007
5008 /**
5009 * Retrieve extended data from the intent.
5010 *
5011 * @param name The name of the desired item.
5012 *
5013 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005014 * or null if no CharSequence array value was found.
5015 *
5016 * @see #putExtra(String, CharSequence[])
5017 */
5018 public CharSequence[] getCharSequenceArrayExtra(String name) {
5019 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5020 }
5021
5022 /**
5023 * Retrieve extended data from the intent.
5024 *
5025 * @param name The name of the desired item.
5026 *
5027 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005028 * or null if no Bundle value was found.
5029 *
5030 * @see #putExtra(String, Bundle)
5031 */
5032 public Bundle getBundleExtra(String name) {
5033 return mExtras == null ? null : mExtras.getBundle(name);
5034 }
5035
5036 /**
5037 * Retrieve extended data from the intent.
5038 *
5039 * @param name The name of the desired item.
5040 *
5041 * @return the value of an item that previously added with putExtra()
5042 * or null if no IBinder value was found.
5043 *
5044 * @see #putExtra(String, IBinder)
5045 *
5046 * @deprecated
5047 * @hide
5048 */
5049 @Deprecated
5050 public IBinder getIBinderExtra(String name) {
5051 return mExtras == null ? null : mExtras.getIBinder(name);
5052 }
5053
5054 /**
5055 * Retrieve extended data from the intent.
5056 *
5057 * @param name The name of the desired item.
5058 * @param defaultValue The default value to return in case no item is
5059 * associated with the key 'name'
5060 *
5061 * @return the value of an item that previously added with putExtra()
5062 * or defaultValue if none was found.
5063 *
5064 * @see #putExtra
5065 *
5066 * @deprecated
5067 * @hide
5068 */
5069 @Deprecated
5070 public Object getExtra(String name, Object defaultValue) {
5071 Object result = defaultValue;
5072 if (mExtras != null) {
5073 Object result2 = mExtras.get(name);
5074 if (result2 != null) {
5075 result = result2;
5076 }
5077 }
5078
5079 return result;
5080 }
5081
5082 /**
5083 * Retrieves a map of extended data from the intent.
5084 *
5085 * @return the map of all extras previously added with putExtra(),
5086 * or null if none have been added.
5087 */
5088 public Bundle getExtras() {
5089 return (mExtras != null)
5090 ? new Bundle(mExtras)
5091 : null;
5092 }
5093
5094 /**
5095 * Retrieve any special flags associated with this intent. You will
5096 * normally just set them with {@link #setFlags} and let the system
5097 * take the appropriate action with them.
5098 *
5099 * @return int The currently set flags.
5100 *
5101 * @see #setFlags
5102 */
5103 public int getFlags() {
5104 return mFlags;
5105 }
5106
Dianne Hackborne7f97212011-02-24 14:40:20 -08005107 /** @hide */
5108 public boolean isExcludingStopped() {
5109 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5110 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5111 }
5112
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005113 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005114 * Retrieve the application package name this Intent is limited to. When
5115 * resolving an Intent, if non-null this limits the resolution to only
5116 * components in the given application package.
5117 *
5118 * @return The name of the application package for the Intent.
5119 *
5120 * @see #resolveActivity
5121 * @see #setPackage
5122 */
5123 public String getPackage() {
5124 return mPackage;
5125 }
5126
5127 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005128 * Retrieve the concrete component associated with the intent. When receiving
5129 * an intent, this is the component that was found to best handle it (that is,
5130 * yourself) and will always be non-null; in all other cases it will be
5131 * null unless explicitly set.
5132 *
5133 * @return The name of the application component to handle the intent.
5134 *
5135 * @see #resolveActivity
5136 * @see #setComponent
5137 */
5138 public ComponentName getComponent() {
5139 return mComponent;
5140 }
5141
5142 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005143 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5144 * used as a hint to the receiver for animations and the like. Null means that there
5145 * is no source bounds.
5146 */
5147 public Rect getSourceBounds() {
5148 return mSourceBounds;
5149 }
5150
5151 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005152 * Return the Activity component that should be used to handle this intent.
5153 * The appropriate component is determined based on the information in the
5154 * intent, evaluated as follows:
5155 *
5156 * <p>If {@link #getComponent} returns an explicit class, that is returned
5157 * without any further consideration.
5158 *
5159 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5160 * category to be considered.
5161 *
5162 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5163 * action.
5164 *
5165 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5166 * this type.
5167 *
5168 * <p>If {@link #addCategory} has added any categories, the activity must
5169 * handle ALL of the categories specified.
5170 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005171 * <p>If {@link #getPackage} is non-NULL, only activity components in
5172 * that application package will be considered.
5173 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005174 * <p>If there are no activities that satisfy all of these conditions, a
5175 * null string is returned.
5176 *
5177 * <p>If multiple activities are found to satisfy the intent, the one with
5178 * the highest priority will be used. If there are multiple activities
5179 * with the same priority, the system will either pick the best activity
5180 * based on user preference, or resolve to a system class that will allow
5181 * the user to pick an activity and forward from there.
5182 *
5183 * <p>This method is implemented simply by calling
5184 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5185 * true.</p>
5186 * <p> This API is called for you as part of starting an activity from an
5187 * intent. You do not normally need to call it yourself.</p>
5188 *
5189 * @param pm The package manager with which to resolve the Intent.
5190 *
5191 * @return Name of the component implementing an activity that can
5192 * display the intent.
5193 *
5194 * @see #setComponent
5195 * @see #getComponent
5196 * @see #resolveActivityInfo
5197 */
5198 public ComponentName resolveActivity(PackageManager pm) {
5199 if (mComponent != null) {
5200 return mComponent;
5201 }
5202
5203 ResolveInfo info = pm.resolveActivity(
5204 this, PackageManager.MATCH_DEFAULT_ONLY);
5205 if (info != null) {
5206 return new ComponentName(
5207 info.activityInfo.applicationInfo.packageName,
5208 info.activityInfo.name);
5209 }
5210
5211 return null;
5212 }
5213
5214 /**
5215 * Resolve the Intent into an {@link ActivityInfo}
5216 * describing the activity that should execute the intent. Resolution
5217 * follows the same rules as described for {@link #resolveActivity}, but
5218 * you get back the completely information about the resolved activity
5219 * instead of just its class name.
5220 *
5221 * @param pm The package manager with which to resolve the Intent.
5222 * @param flags Addition information to retrieve as per
5223 * {@link PackageManager#getActivityInfo(ComponentName, int)
5224 * PackageManager.getActivityInfo()}.
5225 *
5226 * @return PackageManager.ActivityInfo
5227 *
5228 * @see #resolveActivity
5229 */
5230 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5231 ActivityInfo ai = null;
5232 if (mComponent != null) {
5233 try {
5234 ai = pm.getActivityInfo(mComponent, flags);
5235 } catch (PackageManager.NameNotFoundException e) {
5236 // ignore
5237 }
5238 } else {
5239 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005240 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005241 if (info != null) {
5242 ai = info.activityInfo;
5243 }
5244 }
5245
5246 return ai;
5247 }
5248
5249 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005250 * Special function for use by the system to resolve service
5251 * intents to system apps. Throws an exception if there are
5252 * multiple potential matches to the Intent. Returns null if
5253 * there are no matches.
5254 * @hide
5255 */
5256 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5257 if (mComponent != null) {
5258 return mComponent;
5259 }
5260
5261 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5262 if (results == null) {
5263 return null;
5264 }
5265 ComponentName comp = null;
5266 for (int i=0; i<results.size(); i++) {
5267 ResolveInfo ri = results.get(i);
5268 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5269 continue;
5270 }
5271 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5272 ri.serviceInfo.name);
5273 if (comp != null) {
5274 throw new IllegalStateException("Multiple system services handle " + this
5275 + ": " + comp + ", " + foundComp);
5276 }
5277 comp = foundComp;
5278 }
5279 return comp;
5280 }
5281
5282 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005283 * Set the general action to be performed.
5284 *
5285 * @param action An action name, such as ACTION_VIEW. Application-specific
5286 * actions should be prefixed with the vendor's package name.
5287 *
5288 * @return Returns the same Intent object, for chaining multiple calls
5289 * into a single statement.
5290 *
5291 * @see #getAction
5292 */
5293 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005294 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005295 return this;
5296 }
5297
5298 /**
5299 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005300 * clears any type that was previously set by {@link #setType} or
5301 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005302 *
Nick Pellyccae4122012-01-09 14:12:58 -08005303 * <p><em>Note: scheme matching in the Android framework is
5304 * case-sensitive, unlike the formal RFC. As a result,
5305 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005306 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005307 * {@link #setDataAndNormalize}
5308 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005309 *
Nick Pellyccae4122012-01-09 14:12:58 -08005310 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005311 *
5312 * @return Returns the same Intent object, for chaining multiple calls
5313 * into a single statement.
5314 *
5315 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005316 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005317 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005318 */
5319 public Intent setData(Uri data) {
5320 mData = data;
5321 mType = null;
5322 return this;
5323 }
5324
5325 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005326 * Normalize and set the data this intent is operating on.
5327 *
5328 * <p>This method automatically clears any type that was
5329 * previously set (for example, by {@link #setType}).
5330 *
5331 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005332 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005333 * so really this is just a convenience method for
5334 * <pre>
5335 * setData(data.normalize())
5336 * </pre>
5337 *
5338 * @param data The Uri of the data this intent is now targeting.
5339 *
5340 * @return Returns the same Intent object, for chaining multiple calls
5341 * into a single statement.
5342 *
5343 * @see #getData
5344 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005345 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005346 */
5347 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005348 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005349 }
5350
5351 /**
5352 * Set an explicit MIME data type.
5353 *
5354 * <p>This is used to create intents that only specify a type and not data,
5355 * for example to indicate the type of data to return.
5356 *
5357 * <p>This method automatically clears any data that was
5358 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005359 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005360 * <p><em>Note: MIME type matching in the Android framework is
5361 * case-sensitive, unlike formal RFC MIME types. As a result,
5362 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005363 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5364 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005365 *
5366 * @param type The MIME type of the data being handled by this intent.
5367 *
5368 * @return Returns the same Intent object, for chaining multiple calls
5369 * into a single statement.
5370 *
5371 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005372 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005373 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005374 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005375 */
5376 public Intent setType(String type) {
5377 mData = null;
5378 mType = type;
5379 return this;
5380 }
5381
5382 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005383 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005384 *
Nick Pellyccae4122012-01-09 14:12:58 -08005385 * <p>This is used to create intents that only specify a type and not data,
5386 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005387 *
Nick Pellyccae4122012-01-09 14:12:58 -08005388 * <p>This method automatically clears any data that was
5389 * previously set (for example by {@link #setData}).
5390 *
5391 * <p>The MIME type is normalized using
5392 * {@link #normalizeMimeType} before it is set,
5393 * so really this is just a convenience method for
5394 * <pre>
5395 * setType(Intent.normalizeMimeType(type))
5396 * </pre>
5397 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005398 * @param type The MIME type of the data being handled by this intent.
5399 *
5400 * @return Returns the same Intent object, for chaining multiple calls
5401 * into a single statement.
5402 *
Nick Pellyccae4122012-01-09 14:12:58 -08005403 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005404 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005405 * @see #normalizeMimeType
5406 */
5407 public Intent setTypeAndNormalize(String type) {
5408 return setType(normalizeMimeType(type));
5409 }
5410
5411 /**
5412 * (Usually optional) Set the data for the intent along with an explicit
5413 * MIME data type. This method should very rarely be used -- it allows you
5414 * to override the MIME type that would ordinarily be inferred from the
5415 * data with your own type given here.
5416 *
5417 * <p><em>Note: MIME type and Uri scheme matching in the
5418 * Android framework is case-sensitive, unlike the formal RFC definitions.
5419 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005420 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005421 * {@link #setDataAndTypeAndNormalize}
5422 * to ensure that they are converted to lower case.</em>
5423 *
5424 * @param data The Uri of the data this intent is now targeting.
5425 * @param type The MIME type of the data being handled by this intent.
5426 *
5427 * @return Returns the same Intent object, for chaining multiple calls
5428 * into a single statement.
5429 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005430 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005431 * @see #setData
5432 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005433 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005434 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005435 */
5436 public Intent setDataAndType(Uri data, String type) {
5437 mData = data;
5438 mType = type;
5439 return this;
5440 }
5441
5442 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005443 * (Usually optional) Normalize and set both the data Uri and an explicit
5444 * MIME data type. This method should very rarely be used -- it allows you
5445 * to override the MIME type that would ordinarily be inferred from the
5446 * data with your own type given here.
5447 *
5448 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005449 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005450 * before they are set, so really this is just a convenience method for
5451 * <pre>
5452 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5453 * </pre>
5454 *
5455 * @param data The Uri of the data this intent is now targeting.
5456 * @param type The MIME type of the data being handled by this intent.
5457 *
5458 * @return Returns the same Intent object, for chaining multiple calls
5459 * into a single statement.
5460 *
5461 * @see #setType
5462 * @see #setData
5463 * @see #setDataAndType
5464 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005465 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005466 */
5467 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005468 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005469 }
5470
5471 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005472 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005473 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005474 * activities that provide <em>all</em> of the requested categories will be
5475 * used.
5476 *
5477 * @param category The desired category. This can be either one of the
5478 * predefined Intent categories, or a custom category in your own
5479 * namespace.
5480 *
5481 * @return Returns the same Intent object, for chaining multiple calls
5482 * into a single statement.
5483 *
5484 * @see #hasCategory
5485 * @see #removeCategory
5486 */
5487 public Intent addCategory(String category) {
5488 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005489 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005490 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005491 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005492 return this;
5493 }
5494
5495 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005496 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005497 *
5498 * @param category The category to remove.
5499 *
5500 * @see #addCategory
5501 */
5502 public void removeCategory(String category) {
5503 if (mCategories != null) {
5504 mCategories.remove(category);
5505 if (mCategories.size() == 0) {
5506 mCategories = null;
5507 }
5508 }
5509 }
5510
5511 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005512 * Set a selector for this Intent. This is a modification to the kinds of
5513 * things the Intent will match. If the selector is set, it will be used
5514 * when trying to find entities that can handle the Intent, instead of the
5515 * main contents of the Intent. This allows you build an Intent containing
5516 * a generic protocol while targeting it more specifically.
5517 *
5518 * <p>An example of where this may be used is with things like
5519 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5520 * Intent that will launch the Browser application. However, the correct
5521 * main entry point of an application is actually {@link #ACTION_MAIN}
5522 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5523 * used to specify the actual Activity to launch. If you launch the browser
5524 * with something different, undesired behavior may happen if the user has
5525 * previously or later launches it the normal way, since they do not match.
5526 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5527 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5528 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5529 *
5530 * <p>Setting a selector does not impact the behavior of
5531 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5532 * desired behavior of a selector -- it does not impact the base meaning
5533 * of the Intent, just what kinds of things will be matched against it
5534 * when determining who can handle it.</p>
5535 *
5536 * <p>You can not use both a selector and {@link #setPackage(String)} on
5537 * the same base Intent.</p>
5538 *
5539 * @param selector The desired selector Intent; set to null to not use
5540 * a special selector.
5541 */
5542 public void setSelector(Intent selector) {
5543 if (selector == this) {
5544 throw new IllegalArgumentException(
5545 "Intent being set as a selector of itself");
5546 }
5547 if (selector != null && mPackage != null) {
5548 throw new IllegalArgumentException(
5549 "Can't set selector when package name is already set");
5550 }
5551 mSelector = selector;
5552 }
5553
5554 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005555 * Set a {@link ClipData} associated with this Intent. This replaces any
5556 * previously set ClipData.
5557 *
5558 * <p>The ClipData in an intent is not used for Intent matching or other
5559 * such operations. Semantically it is like extras, used to transmit
5560 * additional data with the Intent. The main feature of using this over
5561 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5562 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5563 * items included in the clip data. This is useful, in particular, if
5564 * you want to transmit an Intent containing multiple <code>content:</code>
5565 * URIs for which the recipient may not have global permission to access the
5566 * content provider.
5567 *
5568 * <p>If the ClipData contains items that are themselves Intents, any
5569 * grant flags in those Intents will be ignored. Only the top-level flags
5570 * of the main Intent are respected, and will be applied to all Uri or
5571 * Intent items in the clip (or sub-items of the clip).
5572 *
5573 * <p>The MIME type, label, and icon in the ClipData object are not
5574 * directly used by Intent. Applications should generally rely on the
5575 * MIME type of the Intent itself, not what it may find in the ClipData.
5576 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005577 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005578 *
5579 * @param clip The new clip to set. May be null to clear the current clip.
5580 */
5581 public void setClipData(ClipData clip) {
5582 mClipData = clip;
5583 }
5584
5585 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005586 * Add extended data to the intent. The name must include a package
5587 * prefix, for example the app com.android.contacts would use names
5588 * like "com.android.contacts.ShowAll".
5589 *
5590 * @param name The name of the extra data, with package prefix.
5591 * @param value The boolean data value.
5592 *
5593 * @return Returns the same Intent object, for chaining multiple calls
5594 * into a single statement.
5595 *
5596 * @see #putExtras
5597 * @see #removeExtra
5598 * @see #getBooleanExtra(String, boolean)
5599 */
5600 public Intent putExtra(String name, boolean value) {
5601 if (mExtras == null) {
5602 mExtras = new Bundle();
5603 }
5604 mExtras.putBoolean(name, value);
5605 return this;
5606 }
5607
5608 /**
5609 * Add extended data to the intent. The name must include a package
5610 * prefix, for example the app com.android.contacts would use names
5611 * like "com.android.contacts.ShowAll".
5612 *
5613 * @param name The name of the extra data, with package prefix.
5614 * @param value The byte data value.
5615 *
5616 * @return Returns the same Intent object, for chaining multiple calls
5617 * into a single statement.
5618 *
5619 * @see #putExtras
5620 * @see #removeExtra
5621 * @see #getByteExtra(String, byte)
5622 */
5623 public Intent putExtra(String name, byte value) {
5624 if (mExtras == null) {
5625 mExtras = new Bundle();
5626 }
5627 mExtras.putByte(name, value);
5628 return this;
5629 }
5630
5631 /**
5632 * Add extended data to the intent. The name must include a package
5633 * prefix, for example the app com.android.contacts would use names
5634 * like "com.android.contacts.ShowAll".
5635 *
5636 * @param name The name of the extra data, with package prefix.
5637 * @param value The char data value.
5638 *
5639 * @return Returns the same Intent object, for chaining multiple calls
5640 * into a single statement.
5641 *
5642 * @see #putExtras
5643 * @see #removeExtra
5644 * @see #getCharExtra(String, char)
5645 */
5646 public Intent putExtra(String name, char value) {
5647 if (mExtras == null) {
5648 mExtras = new Bundle();
5649 }
5650 mExtras.putChar(name, value);
5651 return this;
5652 }
5653
5654 /**
5655 * Add extended data to the intent. The name must include a package
5656 * prefix, for example the app com.android.contacts would use names
5657 * like "com.android.contacts.ShowAll".
5658 *
5659 * @param name The name of the extra data, with package prefix.
5660 * @param value The short data value.
5661 *
5662 * @return Returns the same Intent object, for chaining multiple calls
5663 * into a single statement.
5664 *
5665 * @see #putExtras
5666 * @see #removeExtra
5667 * @see #getShortExtra(String, short)
5668 */
5669 public Intent putExtra(String name, short value) {
5670 if (mExtras == null) {
5671 mExtras = new Bundle();
5672 }
5673 mExtras.putShort(name, value);
5674 return this;
5675 }
5676
5677 /**
5678 * Add extended data to the intent. The name must include a package
5679 * prefix, for example the app com.android.contacts would use names
5680 * like "com.android.contacts.ShowAll".
5681 *
5682 * @param name The name of the extra data, with package prefix.
5683 * @param value The integer data value.
5684 *
5685 * @return Returns the same Intent object, for chaining multiple calls
5686 * into a single statement.
5687 *
5688 * @see #putExtras
5689 * @see #removeExtra
5690 * @see #getIntExtra(String, int)
5691 */
5692 public Intent putExtra(String name, int value) {
5693 if (mExtras == null) {
5694 mExtras = new Bundle();
5695 }
5696 mExtras.putInt(name, value);
5697 return this;
5698 }
5699
5700 /**
5701 * Add extended data to the intent. The name must include a package
5702 * prefix, for example the app com.android.contacts would use names
5703 * like "com.android.contacts.ShowAll".
5704 *
5705 * @param name The name of the extra data, with package prefix.
5706 * @param value The long data value.
5707 *
5708 * @return Returns the same Intent object, for chaining multiple calls
5709 * into a single statement.
5710 *
5711 * @see #putExtras
5712 * @see #removeExtra
5713 * @see #getLongExtra(String, long)
5714 */
5715 public Intent putExtra(String name, long value) {
5716 if (mExtras == null) {
5717 mExtras = new Bundle();
5718 }
5719 mExtras.putLong(name, value);
5720 return this;
5721 }
5722
5723 /**
5724 * Add extended data to the intent. The name must include a package
5725 * prefix, for example the app com.android.contacts would use names
5726 * like "com.android.contacts.ShowAll".
5727 *
5728 * @param name The name of the extra data, with package prefix.
5729 * @param value The float data value.
5730 *
5731 * @return Returns the same Intent object, for chaining multiple calls
5732 * into a single statement.
5733 *
5734 * @see #putExtras
5735 * @see #removeExtra
5736 * @see #getFloatExtra(String, float)
5737 */
5738 public Intent putExtra(String name, float value) {
5739 if (mExtras == null) {
5740 mExtras = new Bundle();
5741 }
5742 mExtras.putFloat(name, value);
5743 return this;
5744 }
5745
5746 /**
5747 * Add extended data to the intent. The name must include a package
5748 * prefix, for example the app com.android.contacts would use names
5749 * like "com.android.contacts.ShowAll".
5750 *
5751 * @param name The name of the extra data, with package prefix.
5752 * @param value The double data value.
5753 *
5754 * @return Returns the same Intent object, for chaining multiple calls
5755 * into a single statement.
5756 *
5757 * @see #putExtras
5758 * @see #removeExtra
5759 * @see #getDoubleExtra(String, double)
5760 */
5761 public Intent putExtra(String name, double value) {
5762 if (mExtras == null) {
5763 mExtras = new Bundle();
5764 }
5765 mExtras.putDouble(name, value);
5766 return this;
5767 }
5768
5769 /**
5770 * Add extended data to the intent. The name must include a package
5771 * prefix, for example the app com.android.contacts would use names
5772 * like "com.android.contacts.ShowAll".
5773 *
5774 * @param name The name of the extra data, with package prefix.
5775 * @param value The String data value.
5776 *
5777 * @return Returns the same Intent object, for chaining multiple calls
5778 * into a single statement.
5779 *
5780 * @see #putExtras
5781 * @see #removeExtra
5782 * @see #getStringExtra(String)
5783 */
5784 public Intent putExtra(String name, String value) {
5785 if (mExtras == null) {
5786 mExtras = new Bundle();
5787 }
5788 mExtras.putString(name, value);
5789 return this;
5790 }
5791
5792 /**
5793 * Add extended data to the intent. The name must include a package
5794 * prefix, for example the app com.android.contacts would use names
5795 * like "com.android.contacts.ShowAll".
5796 *
5797 * @param name The name of the extra data, with package prefix.
5798 * @param value The CharSequence data value.
5799 *
5800 * @return Returns the same Intent object, for chaining multiple calls
5801 * into a single statement.
5802 *
5803 * @see #putExtras
5804 * @see #removeExtra
5805 * @see #getCharSequenceExtra(String)
5806 */
5807 public Intent putExtra(String name, CharSequence value) {
5808 if (mExtras == null) {
5809 mExtras = new Bundle();
5810 }
5811 mExtras.putCharSequence(name, value);
5812 return this;
5813 }
5814
5815 /**
5816 * Add extended data to the intent. The name must include a package
5817 * prefix, for example the app com.android.contacts would use names
5818 * like "com.android.contacts.ShowAll".
5819 *
5820 * @param name The name of the extra data, with package prefix.
5821 * @param value The Parcelable data value.
5822 *
5823 * @return Returns the same Intent object, for chaining multiple calls
5824 * into a single statement.
5825 *
5826 * @see #putExtras
5827 * @see #removeExtra
5828 * @see #getParcelableExtra(String)
5829 */
5830 public Intent putExtra(String name, Parcelable value) {
5831 if (mExtras == null) {
5832 mExtras = new Bundle();
5833 }
5834 mExtras.putParcelable(name, value);
5835 return this;
5836 }
5837
5838 /**
5839 * Add extended data to the intent. The name must include a package
5840 * prefix, for example the app com.android.contacts would use names
5841 * like "com.android.contacts.ShowAll".
5842 *
5843 * @param name The name of the extra data, with package prefix.
5844 * @param value The Parcelable[] data value.
5845 *
5846 * @return Returns the same Intent object, for chaining multiple calls
5847 * into a single statement.
5848 *
5849 * @see #putExtras
5850 * @see #removeExtra
5851 * @see #getParcelableArrayExtra(String)
5852 */
5853 public Intent putExtra(String name, Parcelable[] value) {
5854 if (mExtras == null) {
5855 mExtras = new Bundle();
5856 }
5857 mExtras.putParcelableArray(name, value);
5858 return this;
5859 }
5860
5861 /**
5862 * Add extended data to the intent. The name must include a package
5863 * prefix, for example the app com.android.contacts would use names
5864 * like "com.android.contacts.ShowAll".
5865 *
5866 * @param name The name of the extra data, with package prefix.
5867 * @param value The ArrayList<Parcelable> data value.
5868 *
5869 * @return Returns the same Intent object, for chaining multiple calls
5870 * into a single statement.
5871 *
5872 * @see #putExtras
5873 * @see #removeExtra
5874 * @see #getParcelableArrayListExtra(String)
5875 */
5876 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5877 if (mExtras == null) {
5878 mExtras = new Bundle();
5879 }
5880 mExtras.putParcelableArrayList(name, value);
5881 return this;
5882 }
5883
5884 /**
5885 * Add extended data to the intent. The name must include a package
5886 * prefix, for example the app com.android.contacts would use names
5887 * like "com.android.contacts.ShowAll".
5888 *
5889 * @param name The name of the extra data, with package prefix.
5890 * @param value The ArrayList<Integer> data value.
5891 *
5892 * @return Returns the same Intent object, for chaining multiple calls
5893 * into a single statement.
5894 *
5895 * @see #putExtras
5896 * @see #removeExtra
5897 * @see #getIntegerArrayListExtra(String)
5898 */
5899 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5900 if (mExtras == null) {
5901 mExtras = new Bundle();
5902 }
5903 mExtras.putIntegerArrayList(name, value);
5904 return this;
5905 }
5906
5907 /**
5908 * Add extended data to the intent. The name must include a package
5909 * prefix, for example the app com.android.contacts would use names
5910 * like "com.android.contacts.ShowAll".
5911 *
5912 * @param name The name of the extra data, with package prefix.
5913 * @param value The ArrayList<String> data value.
5914 *
5915 * @return Returns the same Intent object, for chaining multiple calls
5916 * into a single statement.
5917 *
5918 * @see #putExtras
5919 * @see #removeExtra
5920 * @see #getStringArrayListExtra(String)
5921 */
5922 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5923 if (mExtras == null) {
5924 mExtras = new Bundle();
5925 }
5926 mExtras.putStringArrayList(name, value);
5927 return this;
5928 }
5929
5930 /**
5931 * Add extended data to the intent. The name must include a package
5932 * prefix, for example the app com.android.contacts would use names
5933 * like "com.android.contacts.ShowAll".
5934 *
5935 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005936 * @param value The ArrayList<CharSequence> data value.
5937 *
5938 * @return Returns the same Intent object, for chaining multiple calls
5939 * into a single statement.
5940 *
5941 * @see #putExtras
5942 * @see #removeExtra
5943 * @see #getCharSequenceArrayListExtra(String)
5944 */
5945 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5946 if (mExtras == null) {
5947 mExtras = new Bundle();
5948 }
5949 mExtras.putCharSequenceArrayList(name, value);
5950 return this;
5951 }
5952
5953 /**
5954 * Add extended data to the intent. The name must include a package
5955 * prefix, for example the app com.android.contacts would use names
5956 * like "com.android.contacts.ShowAll".
5957 *
5958 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005959 * @param value The Serializable data value.
5960 *
5961 * @return Returns the same Intent object, for chaining multiple calls
5962 * into a single statement.
5963 *
5964 * @see #putExtras
5965 * @see #removeExtra
5966 * @see #getSerializableExtra(String)
5967 */
5968 public Intent putExtra(String name, Serializable value) {
5969 if (mExtras == null) {
5970 mExtras = new Bundle();
5971 }
5972 mExtras.putSerializable(name, value);
5973 return this;
5974 }
5975
5976 /**
5977 * Add extended data to the intent. The name must include a package
5978 * prefix, for example the app com.android.contacts would use names
5979 * like "com.android.contacts.ShowAll".
5980 *
5981 * @param name The name of the extra data, with package prefix.
5982 * @param value The boolean array data value.
5983 *
5984 * @return Returns the same Intent object, for chaining multiple calls
5985 * into a single statement.
5986 *
5987 * @see #putExtras
5988 * @see #removeExtra
5989 * @see #getBooleanArrayExtra(String)
5990 */
5991 public Intent putExtra(String name, boolean[] value) {
5992 if (mExtras == null) {
5993 mExtras = new Bundle();
5994 }
5995 mExtras.putBooleanArray(name, value);
5996 return this;
5997 }
5998
5999 /**
6000 * Add extended data to the intent. The name must include a package
6001 * prefix, for example the app com.android.contacts would use names
6002 * like "com.android.contacts.ShowAll".
6003 *
6004 * @param name The name of the extra data, with package prefix.
6005 * @param value The byte array data value.
6006 *
6007 * @return Returns the same Intent object, for chaining multiple calls
6008 * into a single statement.
6009 *
6010 * @see #putExtras
6011 * @see #removeExtra
6012 * @see #getByteArrayExtra(String)
6013 */
6014 public Intent putExtra(String name, byte[] value) {
6015 if (mExtras == null) {
6016 mExtras = new Bundle();
6017 }
6018 mExtras.putByteArray(name, value);
6019 return this;
6020 }
6021
6022 /**
6023 * Add extended data to the intent. The name must include a package
6024 * prefix, for example the app com.android.contacts would use names
6025 * like "com.android.contacts.ShowAll".
6026 *
6027 * @param name The name of the extra data, with package prefix.
6028 * @param value The short array data value.
6029 *
6030 * @return Returns the same Intent object, for chaining multiple calls
6031 * into a single statement.
6032 *
6033 * @see #putExtras
6034 * @see #removeExtra
6035 * @see #getShortArrayExtra(String)
6036 */
6037 public Intent putExtra(String name, short[] value) {
6038 if (mExtras == null) {
6039 mExtras = new Bundle();
6040 }
6041 mExtras.putShortArray(name, value);
6042 return this;
6043 }
6044
6045 /**
6046 * Add extended data to the intent. The name must include a package
6047 * prefix, for example the app com.android.contacts would use names
6048 * like "com.android.contacts.ShowAll".
6049 *
6050 * @param name The name of the extra data, with package prefix.
6051 * @param value The char array data value.
6052 *
6053 * @return Returns the same Intent object, for chaining multiple calls
6054 * into a single statement.
6055 *
6056 * @see #putExtras
6057 * @see #removeExtra
6058 * @see #getCharArrayExtra(String)
6059 */
6060 public Intent putExtra(String name, char[] value) {
6061 if (mExtras == null) {
6062 mExtras = new Bundle();
6063 }
6064 mExtras.putCharArray(name, value);
6065 return this;
6066 }
6067
6068 /**
6069 * Add extended data to the intent. The name must include a package
6070 * prefix, for example the app com.android.contacts would use names
6071 * like "com.android.contacts.ShowAll".
6072 *
6073 * @param name The name of the extra data, with package prefix.
6074 * @param value The int array data value.
6075 *
6076 * @return Returns the same Intent object, for chaining multiple calls
6077 * into a single statement.
6078 *
6079 * @see #putExtras
6080 * @see #removeExtra
6081 * @see #getIntArrayExtra(String)
6082 */
6083 public Intent putExtra(String name, int[] value) {
6084 if (mExtras == null) {
6085 mExtras = new Bundle();
6086 }
6087 mExtras.putIntArray(name, value);
6088 return this;
6089 }
6090
6091 /**
6092 * Add extended data to the intent. The name must include a package
6093 * prefix, for example the app com.android.contacts would use names
6094 * like "com.android.contacts.ShowAll".
6095 *
6096 * @param name The name of the extra data, with package prefix.
6097 * @param value The byte array data value.
6098 *
6099 * @return Returns the same Intent object, for chaining multiple calls
6100 * into a single statement.
6101 *
6102 * @see #putExtras
6103 * @see #removeExtra
6104 * @see #getLongArrayExtra(String)
6105 */
6106 public Intent putExtra(String name, long[] value) {
6107 if (mExtras == null) {
6108 mExtras = new Bundle();
6109 }
6110 mExtras.putLongArray(name, value);
6111 return this;
6112 }
6113
6114 /**
6115 * Add extended data to the intent. The name must include a package
6116 * prefix, for example the app com.android.contacts would use names
6117 * like "com.android.contacts.ShowAll".
6118 *
6119 * @param name The name of the extra data, with package prefix.
6120 * @param value The float array data value.
6121 *
6122 * @return Returns the same Intent object, for chaining multiple calls
6123 * into a single statement.
6124 *
6125 * @see #putExtras
6126 * @see #removeExtra
6127 * @see #getFloatArrayExtra(String)
6128 */
6129 public Intent putExtra(String name, float[] value) {
6130 if (mExtras == null) {
6131 mExtras = new Bundle();
6132 }
6133 mExtras.putFloatArray(name, value);
6134 return this;
6135 }
6136
6137 /**
6138 * Add extended data to the intent. The name must include a package
6139 * prefix, for example the app com.android.contacts would use names
6140 * like "com.android.contacts.ShowAll".
6141 *
6142 * @param name The name of the extra data, with package prefix.
6143 * @param value The double array data value.
6144 *
6145 * @return Returns the same Intent object, for chaining multiple calls
6146 * into a single statement.
6147 *
6148 * @see #putExtras
6149 * @see #removeExtra
6150 * @see #getDoubleArrayExtra(String)
6151 */
6152 public Intent putExtra(String name, double[] value) {
6153 if (mExtras == null) {
6154 mExtras = new Bundle();
6155 }
6156 mExtras.putDoubleArray(name, value);
6157 return this;
6158 }
6159
6160 /**
6161 * Add extended data to the intent. The name must include a package
6162 * prefix, for example the app com.android.contacts would use names
6163 * like "com.android.contacts.ShowAll".
6164 *
6165 * @param name The name of the extra data, with package prefix.
6166 * @param value The String array data value.
6167 *
6168 * @return Returns the same Intent object, for chaining multiple calls
6169 * into a single statement.
6170 *
6171 * @see #putExtras
6172 * @see #removeExtra
6173 * @see #getStringArrayExtra(String)
6174 */
6175 public Intent putExtra(String name, String[] value) {
6176 if (mExtras == null) {
6177 mExtras = new Bundle();
6178 }
6179 mExtras.putStringArray(name, value);
6180 return this;
6181 }
6182
6183 /**
6184 * Add extended data to the intent. The name must include a package
6185 * prefix, for example the app com.android.contacts would use names
6186 * like "com.android.contacts.ShowAll".
6187 *
6188 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006189 * @param value The CharSequence array data value.
6190 *
6191 * @return Returns the same Intent object, for chaining multiple calls
6192 * into a single statement.
6193 *
6194 * @see #putExtras
6195 * @see #removeExtra
6196 * @see #getCharSequenceArrayExtra(String)
6197 */
6198 public Intent putExtra(String name, CharSequence[] value) {
6199 if (mExtras == null) {
6200 mExtras = new Bundle();
6201 }
6202 mExtras.putCharSequenceArray(name, value);
6203 return this;
6204 }
6205
6206 /**
6207 * Add extended data to the intent. The name must include a package
6208 * prefix, for example the app com.android.contacts would use names
6209 * like "com.android.contacts.ShowAll".
6210 *
6211 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006212 * @param value The Bundle data value.
6213 *
6214 * @return Returns the same Intent object, for chaining multiple calls
6215 * into a single statement.
6216 *
6217 * @see #putExtras
6218 * @see #removeExtra
6219 * @see #getBundleExtra(String)
6220 */
6221 public Intent putExtra(String name, Bundle value) {
6222 if (mExtras == null) {
6223 mExtras = new Bundle();
6224 }
6225 mExtras.putBundle(name, value);
6226 return this;
6227 }
6228
6229 /**
6230 * Add extended data to the intent. The name must include a package
6231 * prefix, for example the app com.android.contacts would use names
6232 * like "com.android.contacts.ShowAll".
6233 *
6234 * @param name The name of the extra data, with package prefix.
6235 * @param value The IBinder data value.
6236 *
6237 * @return Returns the same Intent object, for chaining multiple calls
6238 * into a single statement.
6239 *
6240 * @see #putExtras
6241 * @see #removeExtra
6242 * @see #getIBinderExtra(String)
6243 *
6244 * @deprecated
6245 * @hide
6246 */
6247 @Deprecated
6248 public Intent putExtra(String name, IBinder value) {
6249 if (mExtras == null) {
6250 mExtras = new Bundle();
6251 }
6252 mExtras.putIBinder(name, value);
6253 return this;
6254 }
6255
6256 /**
6257 * Copy all extras in 'src' in to this intent.
6258 *
6259 * @param src Contains the extras to copy.
6260 *
6261 * @see #putExtra
6262 */
6263 public Intent putExtras(Intent src) {
6264 if (src.mExtras != null) {
6265 if (mExtras == null) {
6266 mExtras = new Bundle(src.mExtras);
6267 } else {
6268 mExtras.putAll(src.mExtras);
6269 }
6270 }
6271 return this;
6272 }
6273
6274 /**
6275 * Add a set of extended data to the intent. The keys must include a package
6276 * prefix, for example the app com.android.contacts would use names
6277 * like "com.android.contacts.ShowAll".
6278 *
6279 * @param extras The Bundle of extras to add to this intent.
6280 *
6281 * @see #putExtra
6282 * @see #removeExtra
6283 */
6284 public Intent putExtras(Bundle extras) {
6285 if (mExtras == null) {
6286 mExtras = new Bundle();
6287 }
6288 mExtras.putAll(extras);
6289 return this;
6290 }
6291
6292 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006293 * Completely replace the extras in the Intent with the extras in the
6294 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006295 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006296 * @param src The exact extras contained in this Intent are copied
6297 * into the target intent, replacing any that were previously there.
6298 */
6299 public Intent replaceExtras(Intent src) {
6300 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6301 return this;
6302 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006303
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006304 /**
6305 * Completely replace the extras in the Intent with the given Bundle of
6306 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006307 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006308 * @param extras The new set of extras in the Intent, or null to erase
6309 * all extras.
6310 */
6311 public Intent replaceExtras(Bundle extras) {
6312 mExtras = extras != null ? new Bundle(extras) : null;
6313 return this;
6314 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006315
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006316 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006317 * Remove extended data from the intent.
6318 *
6319 * @see #putExtra
6320 */
6321 public void removeExtra(String name) {
6322 if (mExtras != null) {
6323 mExtras.remove(name);
6324 if (mExtras.size() == 0) {
6325 mExtras = null;
6326 }
6327 }
6328 }
6329
6330 /**
6331 * Set special flags controlling how this intent is handled. Most values
6332 * here depend on the type of component being executed by the Intent,
6333 * specifically the FLAG_ACTIVITY_* flags are all for use with
6334 * {@link Context#startActivity Context.startActivity()} and the
6335 * FLAG_RECEIVER_* flags are all for use with
6336 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6337 *
Scott Main7aee61f2011-02-08 11:25:01 -08006338 * <p>See the
6339 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6340 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006341 * the behavior of your application.
6342 *
6343 * @param flags The desired flags.
6344 *
6345 * @return Returns the same Intent object, for chaining multiple calls
6346 * into a single statement.
6347 *
6348 * @see #getFlags
6349 * @see #addFlags
6350 *
6351 * @see #FLAG_GRANT_READ_URI_PERMISSION
6352 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6353 * @see #FLAG_DEBUG_LOG_RESOLUTION
6354 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006355 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006356 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006357 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006358 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006359 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6360 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006361 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006362 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006363 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006364 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006365 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006366 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006367 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006368 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6369 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006370 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006371 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006372 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006373 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6374 */
6375 public Intent setFlags(int flags) {
6376 mFlags = flags;
6377 return this;
6378 }
6379
6380 /**
6381 * Add additional flags to the intent (or with existing flags
6382 * value).
6383 *
6384 * @param flags The new flags to set.
6385 *
6386 * @return Returns the same Intent object, for chaining multiple calls
6387 * into a single statement.
6388 *
6389 * @see #setFlags
6390 */
6391 public Intent addFlags(int flags) {
6392 mFlags |= flags;
6393 return this;
6394 }
6395
6396 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006397 * (Usually optional) Set an explicit application package name that limits
6398 * the components this Intent will resolve to. If left to the default
6399 * value of null, all components in all applications will considered.
6400 * If non-null, the Intent can only match the components in the given
6401 * application package.
6402 *
6403 * @param packageName The name of the application package to handle the
6404 * intent, or null to allow any application package.
6405 *
6406 * @return Returns the same Intent object, for chaining multiple calls
6407 * into a single statement.
6408 *
6409 * @see #getPackage
6410 * @see #resolveActivity
6411 */
6412 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006413 if (packageName != null && mSelector != null) {
6414 throw new IllegalArgumentException(
6415 "Can't set package name when selector is already set");
6416 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006417 mPackage = packageName;
6418 return this;
6419 }
6420
6421 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006422 * (Usually optional) Explicitly set the component to handle the intent.
6423 * If left with the default value of null, the system will determine the
6424 * appropriate class to use based on the other fields (action, data,
6425 * type, categories) in the Intent. If this class is defined, the
6426 * specified class will always be used regardless of the other fields. You
6427 * should only set this value when you know you absolutely want a specific
6428 * class to be used; otherwise it is better to let the system find the
6429 * appropriate class so that you will respect the installed applications
6430 * and user preferences.
6431 *
6432 * @param component The name of the application component to handle the
6433 * intent, or null to let the system find one for you.
6434 *
6435 * @return Returns the same Intent object, for chaining multiple calls
6436 * into a single statement.
6437 *
6438 * @see #setClass
6439 * @see #setClassName(Context, String)
6440 * @see #setClassName(String, String)
6441 * @see #getComponent
6442 * @see #resolveActivity
6443 */
6444 public Intent setComponent(ComponentName component) {
6445 mComponent = component;
6446 return this;
6447 }
6448
6449 /**
6450 * Convenience for calling {@link #setComponent} with an
6451 * explicit class name.
6452 *
6453 * @param packageContext A Context of the application package implementing
6454 * this class.
6455 * @param className The name of a class inside of the application package
6456 * that will be used as the component for this Intent.
6457 *
6458 * @return Returns the same Intent object, for chaining multiple calls
6459 * into a single statement.
6460 *
6461 * @see #setComponent
6462 * @see #setClass
6463 */
6464 public Intent setClassName(Context packageContext, String className) {
6465 mComponent = new ComponentName(packageContext, className);
6466 return this;
6467 }
6468
6469 /**
6470 * Convenience for calling {@link #setComponent} with an
6471 * explicit application package name and class name.
6472 *
6473 * @param packageName The name of the package implementing the desired
6474 * component.
6475 * @param className The name of a class inside of the application package
6476 * that will be used as the component for this Intent.
6477 *
6478 * @return Returns the same Intent object, for chaining multiple calls
6479 * into a single statement.
6480 *
6481 * @see #setComponent
6482 * @see #setClass
6483 */
6484 public Intent setClassName(String packageName, String className) {
6485 mComponent = new ComponentName(packageName, className);
6486 return this;
6487 }
6488
6489 /**
6490 * Convenience for calling {@link #setComponent(ComponentName)} with the
6491 * name returned by a {@link Class} object.
6492 *
6493 * @param packageContext A Context of the application package implementing
6494 * this class.
6495 * @param cls The class name to set, equivalent to
6496 * <code>setClassName(context, cls.getName())</code>.
6497 *
6498 * @return Returns the same Intent object, for chaining multiple calls
6499 * into a single statement.
6500 *
6501 * @see #setComponent
6502 */
6503 public Intent setClass(Context packageContext, Class<?> cls) {
6504 mComponent = new ComponentName(packageContext, cls);
6505 return this;
6506 }
6507
6508 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006509 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6510 * used as a hint to the receiver for animations and the like. Null means that there
6511 * is no source bounds.
6512 */
6513 public void setSourceBounds(Rect r) {
6514 if (r != null) {
6515 mSourceBounds = new Rect(r);
6516 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006517 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006518 }
6519 }
6520
Tor Norbyed9273d62013-05-30 15:59:53 -07006521 /** @hide */
6522 @IntDef(flag = true,
6523 value = {
6524 FILL_IN_ACTION,
6525 FILL_IN_DATA,
6526 FILL_IN_CATEGORIES,
6527 FILL_IN_COMPONENT,
6528 FILL_IN_PACKAGE,
6529 FILL_IN_SOURCE_BOUNDS,
6530 FILL_IN_SELECTOR,
6531 FILL_IN_CLIP_DATA
6532 })
6533 @Retention(RetentionPolicy.SOURCE)
6534 public @interface FillInFlags {}
6535
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006536 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006537 * Use with {@link #fillIn} to allow the current action value to be
6538 * overwritten, even if it is already set.
6539 */
6540 public static final int FILL_IN_ACTION = 1<<0;
6541
6542 /**
6543 * Use with {@link #fillIn} to allow the current data or type value
6544 * overwritten, even if it is already set.
6545 */
6546 public static final int FILL_IN_DATA = 1<<1;
6547
6548 /**
6549 * Use with {@link #fillIn} to allow the current categories to be
6550 * overwritten, even if they are already set.
6551 */
6552 public static final int FILL_IN_CATEGORIES = 1<<2;
6553
6554 /**
6555 * Use with {@link #fillIn} to allow the current component value to be
6556 * overwritten, even if it is already set.
6557 */
6558 public static final int FILL_IN_COMPONENT = 1<<3;
6559
6560 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006561 * Use with {@link #fillIn} to allow the current package value to be
6562 * overwritten, even if it is already set.
6563 */
6564 public static final int FILL_IN_PACKAGE = 1<<4;
6565
6566 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006567 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006568 * overwritten, even if it is already set.
6569 */
6570 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6571
6572 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006573 * Use with {@link #fillIn} to allow the current selector to be
6574 * overwritten, even if it is already set.
6575 */
6576 public static final int FILL_IN_SELECTOR = 1<<6;
6577
6578 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006579 * Use with {@link #fillIn} to allow the current ClipData to be
6580 * overwritten, even if it is already set.
6581 */
6582 public static final int FILL_IN_CLIP_DATA = 1<<7;
6583
6584 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006585 * Copy the contents of <var>other</var> in to this object, but only
6586 * where fields are not defined by this object. For purposes of a field
6587 * being defined, the following pieces of data in the Intent are
6588 * considered to be separate fields:
6589 *
6590 * <ul>
6591 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006592 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006593 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6594 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006595 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006596 * <li> component, as set by {@link #setComponent(ComponentName)} or
6597 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006598 * <li> source bounds, as set by {@link #setSourceBounds}.
6599 * <li> selector, as set by {@link #setSelector(Intent)}.
6600 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006601 * <li> each top-level name in the associated extras.
6602 * </ul>
6603 *
6604 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006605 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006606 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6607 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6608 * the restriction where the corresponding field will not be replaced if
6609 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006610 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006611 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6612 * is explicitly specified. The selector will only be copied if
6613 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006614 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006615 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6616 * and Intent B with {action="gotit", data-type="some/thing",
6617 * categories="one","two"}.
6618 *
6619 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6620 * containing: {action="gotit", data-type="some/thing",
6621 * categories="bar"}.
6622 *
6623 * @param other Another Intent whose values are to be used to fill in
6624 * the current one.
6625 * @param flags Options to control which fields can be filled in.
6626 *
6627 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006628 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006629 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6630 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6631 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006632 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006633 @FillInFlags
6634 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006635 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006636 if (other.mAction != null
6637 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006638 mAction = other.mAction;
6639 changes |= FILL_IN_ACTION;
6640 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006641 if ((other.mData != null || other.mType != null)
6642 && ((mData == null && mType == null)
6643 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006644 mData = other.mData;
6645 mType = other.mType;
6646 changes |= FILL_IN_DATA;
6647 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006648 if (other.mCategories != null
6649 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006650 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006651 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006652 }
6653 changes |= FILL_IN_CATEGORIES;
6654 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006655 if (other.mPackage != null
6656 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006657 // Only do this if mSelector is not set.
6658 if (mSelector == null) {
6659 mPackage = other.mPackage;
6660 changes |= FILL_IN_PACKAGE;
6661 }
6662 }
6663 // Selector is special: it can only be set if explicitly allowed,
6664 // for the same reason as the component name.
6665 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6666 if (mPackage == null) {
6667 mSelector = new Intent(other.mSelector);
6668 mPackage = null;
6669 changes |= FILL_IN_SELECTOR;
6670 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006671 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006672 if (other.mClipData != null
6673 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6674 mClipData = other.mClipData;
6675 changes |= FILL_IN_CLIP_DATA;
6676 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006677 // Component is special: it can -only- be set if explicitly allowed,
6678 // since otherwise the sender could force the intent somewhere the
6679 // originator didn't intend.
6680 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006681 mComponent = other.mComponent;
6682 changes |= FILL_IN_COMPONENT;
6683 }
6684 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006685 if (other.mSourceBounds != null
6686 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6687 mSourceBounds = new Rect(other.mSourceBounds);
6688 changes |= FILL_IN_SOURCE_BOUNDS;
6689 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006690 if (mExtras == null) {
6691 if (other.mExtras != null) {
6692 mExtras = new Bundle(other.mExtras);
6693 }
6694 } else if (other.mExtras != null) {
6695 try {
6696 Bundle newb = new Bundle(other.mExtras);
6697 newb.putAll(mExtras);
6698 mExtras = newb;
6699 } catch (RuntimeException e) {
6700 // Modifying the extras can cause us to unparcel the contents
6701 // of the bundle, and if we do this in the system process that
6702 // may fail. We really should handle this (i.e., the Bundle
6703 // impl shouldn't be on top of a plain map), but for now just
6704 // ignore it and keep the original contents. :(
6705 Log.w("Intent", "Failure filling in extras", e);
6706 }
6707 }
6708 return changes;
6709 }
6710
6711 /**
6712 * Wrapper class holding an Intent and implementing comparisons on it for
6713 * the purpose of filtering. The class implements its
6714 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6715 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6716 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6717 * on the wrapped Intent.
6718 */
6719 public static final class FilterComparison {
6720 private final Intent mIntent;
6721 private final int mHashCode;
6722
6723 public FilterComparison(Intent intent) {
6724 mIntent = intent;
6725 mHashCode = intent.filterHashCode();
6726 }
6727
6728 /**
6729 * Return the Intent that this FilterComparison represents.
6730 * @return Returns the Intent held by the FilterComparison. Do
6731 * not modify!
6732 */
6733 public Intent getIntent() {
6734 return mIntent;
6735 }
6736
6737 @Override
6738 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006739 if (obj instanceof FilterComparison) {
6740 Intent other = ((FilterComparison)obj).mIntent;
6741 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006742 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006743 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006744 }
6745
6746 @Override
6747 public int hashCode() {
6748 return mHashCode;
6749 }
6750 }
6751
6752 /**
6753 * Determine if two intents are the same for the purposes of intent
6754 * resolution (filtering). That is, if their action, data, type,
6755 * class, and categories are the same. This does <em>not</em> compare
6756 * any extra data included in the intents.
6757 *
6758 * @param other The other Intent to compare against.
6759 *
6760 * @return Returns true if action, data, type, class, and categories
6761 * are the same.
6762 */
6763 public boolean filterEquals(Intent other) {
6764 if (other == null) {
6765 return false;
6766 }
6767 if (mAction != other.mAction) {
6768 if (mAction != null) {
6769 if (!mAction.equals(other.mAction)) {
6770 return false;
6771 }
6772 } else {
6773 if (!other.mAction.equals(mAction)) {
6774 return false;
6775 }
6776 }
6777 }
6778 if (mData != other.mData) {
6779 if (mData != null) {
6780 if (!mData.equals(other.mData)) {
6781 return false;
6782 }
6783 } else {
6784 if (!other.mData.equals(mData)) {
6785 return false;
6786 }
6787 }
6788 }
6789 if (mType != other.mType) {
6790 if (mType != null) {
6791 if (!mType.equals(other.mType)) {
6792 return false;
6793 }
6794 } else {
6795 if (!other.mType.equals(mType)) {
6796 return false;
6797 }
6798 }
6799 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006800 if (mPackage != other.mPackage) {
6801 if (mPackage != null) {
6802 if (!mPackage.equals(other.mPackage)) {
6803 return false;
6804 }
6805 } else {
6806 if (!other.mPackage.equals(mPackage)) {
6807 return false;
6808 }
6809 }
6810 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006811 if (mComponent != other.mComponent) {
6812 if (mComponent != null) {
6813 if (!mComponent.equals(other.mComponent)) {
6814 return false;
6815 }
6816 } else {
6817 if (!other.mComponent.equals(mComponent)) {
6818 return false;
6819 }
6820 }
6821 }
6822 if (mCategories != other.mCategories) {
6823 if (mCategories != null) {
6824 if (!mCategories.equals(other.mCategories)) {
6825 return false;
6826 }
6827 } else {
6828 if (!other.mCategories.equals(mCategories)) {
6829 return false;
6830 }
6831 }
6832 }
6833
6834 return true;
6835 }
6836
6837 /**
6838 * Generate hash code that matches semantics of filterEquals().
6839 *
6840 * @return Returns the hash value of the action, data, type, class, and
6841 * categories.
6842 *
6843 * @see #filterEquals
6844 */
6845 public int filterHashCode() {
6846 int code = 0;
6847 if (mAction != null) {
6848 code += mAction.hashCode();
6849 }
6850 if (mData != null) {
6851 code += mData.hashCode();
6852 }
6853 if (mType != null) {
6854 code += mType.hashCode();
6855 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006856 if (mPackage != null) {
6857 code += mPackage.hashCode();
6858 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006859 if (mComponent != null) {
6860 code += mComponent.hashCode();
6861 }
6862 if (mCategories != null) {
6863 code += mCategories.hashCode();
6864 }
6865 return code;
6866 }
6867
6868 @Override
6869 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006870 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006871
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006872 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006873 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006874 b.append(" }");
6875
6876 return b.toString();
6877 }
6878
6879 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006880 public String toInsecureString() {
6881 StringBuilder b = new StringBuilder(128);
6882
6883 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006884 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006885 b.append(" }");
6886
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006887 return b.toString();
6888 }
Romain Guy4969af72009-06-17 10:53:19 -07006889
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006890 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006891 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006892 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006893
6894 b.append("Intent { ");
6895 toShortString(b, false, true, true, true);
6896 b.append(" }");
6897
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006898 return b.toString();
6899 }
6900
6901 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006902 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6903 StringBuilder b = new StringBuilder(128);
6904 toShortString(b, secure, comp, extras, clip);
6905 return b.toString();
6906 }
6907
6908 /** @hide */
6909 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6910 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006911 boolean first = true;
6912 if (mAction != null) {
6913 b.append("act=").append(mAction);
6914 first = false;
6915 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006916 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006917 if (!first) {
6918 b.append(' ');
6919 }
6920 first = false;
6921 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006922 for (int i=0; i<mCategories.size(); i++) {
6923 if (i > 0) b.append(',');
6924 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006925 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006926 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006927 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006928 if (mData != null) {
6929 if (!first) {
6930 b.append(' ');
6931 }
6932 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006933 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006934 if (secure) {
6935 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006936 } else {
6937 b.append(mData);
6938 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006939 }
6940 if (mType != null) {
6941 if (!first) {
6942 b.append(' ');
6943 }
6944 first = false;
6945 b.append("typ=").append(mType);
6946 }
6947 if (mFlags != 0) {
6948 if (!first) {
6949 b.append(' ');
6950 }
6951 first = false;
6952 b.append("flg=0x").append(Integer.toHexString(mFlags));
6953 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006954 if (mPackage != null) {
6955 if (!first) {
6956 b.append(' ');
6957 }
6958 first = false;
6959 b.append("pkg=").append(mPackage);
6960 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006961 if (comp && mComponent != null) {
6962 if (!first) {
6963 b.append(' ');
6964 }
6965 first = false;
6966 b.append("cmp=").append(mComponent.flattenToShortString());
6967 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006968 if (mSourceBounds != null) {
6969 if (!first) {
6970 b.append(' ');
6971 }
6972 first = false;
6973 b.append("bnds=").append(mSourceBounds.toShortString());
6974 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006975 if (mClipData != null) {
6976 if (!first) {
6977 b.append(' ');
6978 }
6979 first = false;
6980 if (clip) {
6981 b.append("clip={");
6982 mClipData.toShortString(b);
6983 b.append('}');
6984 } else {
6985 b.append("(has clip)");
6986 }
6987 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006988 if (extras && mExtras != null) {
6989 if (!first) {
6990 b.append(' ');
6991 }
6992 first = false;
6993 b.append("(has extras)");
6994 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006995 if (mSelector != null) {
6996 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006997 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006998 b.append("}");
6999 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007000 }
7001
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007002 /**
7003 * Call {@link #toUri} with 0 flags.
7004 * @deprecated Use {@link #toUri} instead.
7005 */
7006 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007007 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007008 return toUri(0);
7009 }
7010
7011 /**
7012 * Convert this Intent into a String holding a URI representation of it.
7013 * The returned URI string has been properly URI encoded, so it can be
7014 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7015 * Intent's data as the base URI, with an additional fragment describing
7016 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007017 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007018 * <p>You can convert the returned string back to an Intent with
7019 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007020 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007021 * @param flags Additional operating flags. Either 0 or
7022 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007023 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007024 * @return Returns a URI encoding URI string describing the entire contents
7025 * of the Intent.
7026 */
7027 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007028 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007029 String scheme = null;
7030 if (mData != null) {
7031 String data = mData.toString();
7032 if ((flags&URI_INTENT_SCHEME) != 0) {
7033 final int N = data.length();
7034 for (int i=0; i<N; i++) {
7035 char c = data.charAt(i);
7036 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7037 || c == '.' || c == '-') {
7038 continue;
7039 }
7040 if (c == ':' && i > 0) {
7041 // Valid scheme.
7042 scheme = data.substring(0, i);
7043 uri.append("intent:");
7044 data = data.substring(i+1);
7045 break;
7046 }
Tom Taylord4a47292009-12-21 13:59:18 -08007047
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007048 // No scheme.
7049 break;
7050 }
7051 }
7052 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007053
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007054 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7055 uri.append("intent:");
7056 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007057
7058 uri.append("#Intent;");
7059
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007060 toUriInner(uri, scheme, flags);
7061 if (mSelector != null) {
7062 uri.append("SEL;");
7063 // Note that for now we are not going to try to handle the
7064 // data part; not clear how to represent this as a URI, and
7065 // not much utility in it.
7066 mSelector.toUriInner(uri, null, flags);
7067 }
7068
7069 uri.append("end");
7070
7071 return uri.toString();
7072 }
7073
7074 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007075 if (scheme != null) {
7076 uri.append("scheme=").append(scheme).append(';');
7077 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007078 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007079 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007080 }
7081 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007082 for (int i=0; i<mCategories.size(); i++) {
7083 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007084 }
7085 }
7086 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007087 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007088 }
7089 if (mFlags != 0) {
7090 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7091 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007092 if (mPackage != null) {
7093 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7094 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007095 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007096 uri.append("component=").append(Uri.encode(
7097 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007098 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007099 if (mSourceBounds != null) {
7100 uri.append("sourceBounds=")
7101 .append(Uri.encode(mSourceBounds.flattenToString()))
7102 .append(';');
7103 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007104 if (mExtras != null) {
7105 for (String key : mExtras.keySet()) {
7106 final Object value = mExtras.get(key);
7107 char entryType =
7108 value instanceof String ? 'S' :
7109 value instanceof Boolean ? 'B' :
7110 value instanceof Byte ? 'b' :
7111 value instanceof Character ? 'c' :
7112 value instanceof Double ? 'd' :
7113 value instanceof Float ? 'f' :
7114 value instanceof Integer ? 'i' :
7115 value instanceof Long ? 'l' :
7116 value instanceof Short ? 's' :
7117 '\0';
7118
7119 if (entryType != '\0') {
7120 uri.append(entryType);
7121 uri.append('.');
7122 uri.append(Uri.encode(key));
7123 uri.append('=');
7124 uri.append(Uri.encode(value.toString()));
7125 uri.append(';');
7126 }
7127 }
7128 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007129 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007130
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007131 public int describeContents() {
7132 return (mExtras != null) ? mExtras.describeContents() : 0;
7133 }
7134
7135 public void writeToParcel(Parcel out, int flags) {
7136 out.writeString(mAction);
7137 Uri.writeToParcel(out, mData);
7138 out.writeString(mType);
7139 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007140 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007141 ComponentName.writeToParcel(mComponent, out);
7142
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007143 if (mSourceBounds != null) {
7144 out.writeInt(1);
7145 mSourceBounds.writeToParcel(out, flags);
7146 } else {
7147 out.writeInt(0);
7148 }
7149
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007150 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007151 final int N = mCategories.size();
7152 out.writeInt(N);
7153 for (int i=0; i<N; i++) {
7154 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007155 }
7156 } else {
7157 out.writeInt(0);
7158 }
7159
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007160 if (mSelector != null) {
7161 out.writeInt(1);
7162 mSelector.writeToParcel(out, flags);
7163 } else {
7164 out.writeInt(0);
7165 }
7166
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007167 if (mClipData != null) {
7168 out.writeInt(1);
7169 mClipData.writeToParcel(out, flags);
7170 } else {
7171 out.writeInt(0);
7172 }
7173
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007174 out.writeBundle(mExtras);
7175 }
7176
7177 public static final Parcelable.Creator<Intent> CREATOR
7178 = new Parcelable.Creator<Intent>() {
7179 public Intent createFromParcel(Parcel in) {
7180 return new Intent(in);
7181 }
7182 public Intent[] newArray(int size) {
7183 return new Intent[size];
7184 }
7185 };
7186
Dianne Hackborneb034652009-09-07 00:49:58 -07007187 /** @hide */
7188 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007189 readFromParcel(in);
7190 }
7191
7192 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007193 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007194 mData = Uri.CREATOR.createFromParcel(in);
7195 mType = in.readString();
7196 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007197 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007198 mComponent = ComponentName.readFromParcel(in);
7199
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007200 if (in.readInt() != 0) {
7201 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7202 }
7203
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007204 int N = in.readInt();
7205 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007206 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 int i;
7208 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007209 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007210 }
7211 } else {
7212 mCategories = null;
7213 }
7214
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007215 if (in.readInt() != 0) {
7216 mSelector = new Intent(in);
7217 }
7218
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007219 if (in.readInt() != 0) {
7220 mClipData = new ClipData(in);
7221 }
7222
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007223 mExtras = in.readBundle();
7224 }
7225
7226 /**
7227 * Parses the "intent" element (and its children) from XML and instantiates
7228 * an Intent object. The given XML parser should be located at the tag
7229 * where parsing should start (often named "intent"), from which the
7230 * basic action, data, type, and package and class name will be
7231 * retrieved. The function will then parse in to any child elements,
7232 * looking for <category android:name="xxx"> tags to add categories and
7233 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7234 * to the intent.
7235 *
7236 * @param resources The Resources to use when inflating resources.
7237 * @param parser The XML parser pointing at an "intent" tag.
7238 * @param attrs The AttributeSet interface for retrieving extended
7239 * attribute data at the current <var>parser</var> location.
7240 * @return An Intent object matching the XML data.
7241 * @throws XmlPullParserException If there was an XML parsing error.
7242 * @throws IOException If there was an I/O error.
7243 */
7244 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7245 throws XmlPullParserException, IOException {
7246 Intent intent = new Intent();
7247
7248 TypedArray sa = resources.obtainAttributes(attrs,
7249 com.android.internal.R.styleable.Intent);
7250
7251 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7252
7253 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7254 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7255 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7256
7257 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7258 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7259 if (packageName != null && className != null) {
7260 intent.setComponent(new ComponentName(packageName, className));
7261 }
7262
7263 sa.recycle();
7264
7265 int outerDepth = parser.getDepth();
7266 int type;
7267 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7268 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7269 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7270 continue;
7271 }
7272
7273 String nodeName = parser.getName();
7274 if (nodeName.equals("category")) {
7275 sa = resources.obtainAttributes(attrs,
7276 com.android.internal.R.styleable.IntentCategory);
7277 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7278 sa.recycle();
7279
7280 if (cat != null) {
7281 intent.addCategory(cat);
7282 }
7283 XmlUtils.skipCurrentTag(parser);
7284
7285 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007286 if (intent.mExtras == null) {
7287 intent.mExtras = new Bundle();
7288 }
7289 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7290 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007291
7292 } else {
7293 XmlUtils.skipCurrentTag(parser);
7294 }
7295 }
7296
7297 return intent;
7298 }
Nick Pellyccae4122012-01-09 14:12:58 -08007299
7300 /**
7301 * Normalize a MIME data type.
7302 *
7303 * <p>A normalized MIME type has white-space trimmed,
7304 * content-type parameters removed, and is lower-case.
7305 * This aligns the type with Android best practices for
7306 * intent filtering.
7307 *
7308 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7309 * "text/x-vCard" becomes "text/x-vcard".
7310 *
7311 * <p>All MIME types received from outside Android (such as user input,
7312 * or external sources like Bluetooth, NFC, or the Internet) should
7313 * be normalized before they are used to create an Intent.
7314 *
7315 * @param type MIME data type to normalize
7316 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007317 * @see #setType
7318 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007319 */
7320 public static String normalizeMimeType(String type) {
7321 if (type == null) {
7322 return null;
7323 }
7324
Elliott Hughescb64d432013-08-02 10:00:44 -07007325 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007326
7327 final int semicolonIndex = type.indexOf(';');
7328 if (semicolonIndex != -1) {
7329 type = type.substring(0, semicolonIndex);
7330 }
7331 return type;
7332 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007333
7334 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007335 * Prepare this {@link Intent} to leave an app process.
7336 *
7337 * @hide
7338 */
7339 public void prepareToLeaveProcess() {
7340 setAllowFds(false);
7341
7342 if (mSelector != null) {
7343 mSelector.prepareToLeaveProcess();
7344 }
7345 if (mClipData != null) {
7346 mClipData.prepareToLeaveProcess();
7347 }
7348
7349 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7350 // There are several ACTION_MEDIA_* broadcasts that send file://
7351 // Uris, so only check common actions.
7352 if (ACTION_VIEW.equals(mAction) ||
7353 ACTION_EDIT.equals(mAction) ||
7354 ACTION_ATTACH_DATA.equals(mAction)) {
7355 mData.checkFileUriExposed("Intent.getData()");
7356 }
7357 }
7358 }
7359
7360 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007361 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007362 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7363 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007364 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007365 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007366 * @hide
7367 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007368 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007369 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007370 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007371
7372 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007373 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007374
7375 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007376 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007377 try {
7378 // Inspect target intent to see if we need to migrate
7379 final Intent target = getParcelableExtra(EXTRA_INTENT);
7380 if (target != null && target.migrateExtraStreamToClipData()) {
7381 // Since we migrated in child, we need to promote ClipData
7382 // and flags to ourselves to grant.
7383 setClipData(target.getClipData());
7384 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007385 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkeye66c1772013-09-20 14:30:59 -07007386 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007387 return true;
7388 } else {
7389 return false;
7390 }
7391 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007392 }
7393
7394 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007395 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007396 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7397 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7398 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7399 if (stream != null || text != null || htmlText != null) {
7400 final ClipData clipData = new ClipData(
7401 null, new String[] { getType() },
7402 new ClipData.Item(text, htmlText, null, stream));
7403 setClipData(clipData);
7404 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007405 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007406 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007407 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007408 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007409
7410 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007411 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007412 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7413 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7414 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7415 int num = -1;
7416 if (streams != null) {
7417 num = streams.size();
7418 }
7419 if (texts != null) {
7420 if (num >= 0 && num != texts.size()) {
7421 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007422 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007423 }
7424 num = texts.size();
7425 }
7426 if (htmlTexts != null) {
7427 if (num >= 0 && num != htmlTexts.size()) {
7428 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007429 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007430 }
7431 num = htmlTexts.size();
7432 }
7433 if (num > 0) {
7434 final ClipData clipData = new ClipData(
7435 null, new String[] { getType() },
7436 makeClipItem(streams, texts, htmlTexts, 0));
7437
7438 for (int i = 1; i < num; i++) {
7439 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7440 }
7441
7442 setClipData(clipData);
7443 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007444 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007445 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007446 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007447 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007448 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007449
7450 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007451 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007452
7453 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7454 ArrayList<String> htmlTexts, int which) {
7455 Uri uri = streams != null ? streams.get(which) : null;
7456 CharSequence text = texts != null ? texts.get(which) : null;
7457 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7458 return new ClipData.Item(text, htmlText, null, uri);
7459 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007460
7461 /** @hide */
7462 public boolean isDocument() {
7463 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7464 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007465}