blob: 111b4d6efa6e9583ca43d1a66e90d11b27e2fe81 [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
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070020import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050023import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050025import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060026import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000038import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050039import android.os.ResultReceiver;
40import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070041import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010042import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070043import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070044import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import android.util.AttributeSet;
49import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080050import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import org.xmlpull.v1.XmlPullParser;
52import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070053import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054
55import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080056import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
Jason Monk2f68e8a2016-02-23 17:57:28 -050068import static android.content.ContentProvider.maybeAddUserId;
69
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700118 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700189 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700342 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700361 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000541 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
542 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #ACTION_UID_REMOVED}
544 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700545 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700546 * <li> {@link #ACTION_POWER_DISCONNECTED}
547 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * </ul>
549 *
550 * <h3>Standard Categories</h3>
551 *
552 * <p>These are the current standard categories that can be used to further
553 * clarify an Intent via {@link #addCategory}.
554 *
555 * <ul>
556 * <li> {@link #CATEGORY_DEFAULT}
557 * <li> {@link #CATEGORY_BROWSABLE}
558 * <li> {@link #CATEGORY_TAB}
559 * <li> {@link #CATEGORY_ALTERNATIVE}
560 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
561 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_HOME}
564 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400566 * <li> {@link #CATEGORY_CAR_DOCK}
567 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500568 * <li> {@link #CATEGORY_LE_DESK_DOCK}
569 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200570 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700571 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * </ul>
573 *
574 * <h3>Standard Extra Data</h3>
575 *
576 * <p>These are the current standard fields that can be used as extra data via
577 * {@link #putExtra}.
578 *
579 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_ALARM_COUNT}
581 * <li> {@link #EXTRA_BCC}
582 * <li> {@link #EXTRA_CC}
583 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
584 * <li> {@link #EXTRA_DATA_REMOVED}
585 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500586 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
587 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_DOCK_STATE_CAR}
589 * <li> {@link #EXTRA_DOCK_STATE_DESK}
590 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
591 * <li> {@link #EXTRA_DONT_KILL_APP}
592 * <li> {@link #EXTRA_EMAIL}
593 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700594 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700596 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700598 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
600 * <li> {@link #EXTRA_REPLACING}
601 * <li> {@link #EXTRA_SHORTCUT_ICON}
602 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
603 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_SHORTCUT_NAME}
606 * <li> {@link #EXTRA_SUBJECT}
607 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_TITLE}
610 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * </ul>
612 *
613 * <h3>Flags</h3>
614 *
615 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800616 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
617 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800619public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700620 private static final String ATTR_ACTION = "action";
621 private static final String TAG_CATEGORIES = "categories";
622 private static final String ATTR_CATEGORY = "category";
623 private static final String TAG_EXTRA = "extra";
624 private static final String ATTR_TYPE = "type";
625 private static final String ATTR_COMPONENT = "component";
626 private static final String ATTR_DATA = "data";
627 private static final String ATTR_FLAGS = "flags";
628
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700629 // ---------------------------------------------------------------------
630 // ---------------------------------------------------------------------
631 // Standard intent activity actions (see action variable).
632
633 /**
634 * Activity Action: Start as a main entry point, does not expect to
635 * receive data.
636 * <p>Input: nothing
637 * <p>Output: nothing
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Display the data to the user. This is the most common
644 * action performed on data -- it is the generic action you can use on
645 * a piece of data to get the most reasonable thing to occur. For example,
646 * when used on a contacts entry it will view the entry; when used on a
647 * mailto: URI it will bring up a compose window filled with the information
648 * supplied by the URI; when used with a tel: URI it will invoke the
649 * dialer.
650 * <p>Input: {@link #getData} is URI from which to retrieve data.
651 * <p>Output: nothing.
652 */
653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
654 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700656 /**
657 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
658 * performed on a piece of data.
659 */
660 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700662 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900663 * Activity Action: Quick view the data. Launches a quick viewer for
664 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900665 * <p>Activities handling this intent action should handle the vast majority of
666 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * <p>Input: {@link #getData} is a mandatory content URI of the item to
668 * preview. {@link #getClipData} contains an optional list of content URIs
669 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
670 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700671 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
675
676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * Used to indicate that some piece of data should be attached to some other
678 * place. For example, image data could be attached to a contact. It is up
679 * to the recipient to decide where the data should be attached; the intent
680 * does not specify the ultimate destination.
681 * <p>Input: {@link #getData} is URI of data to be attached.
682 * <p>Output: nothing.
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700687 /**
688 * Activity Action: Provide explicit editable access to the given data.
689 * <p>Input: {@link #getData} is URI of data to be edited.
690 * <p>Output: nothing.
691 */
692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
693 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700695 /**
696 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
697 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
698 * The extras can contain type specific data to pass through to the editing/creating
699 * activity.
700 * <p>Output: The URI of the item that was picked. This must be a content:
701 * URI so that any receiver can access it.
702 */
703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
704 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800705
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700706 /**
707 * Activity Action: Pick an item from the data, returning what was selected.
708 * <p>Input: {@link #getData} is URI containing a directory of data
709 * (vnd.android.cursor.dir/*) from which to pick an item.
710 * <p>Output: The URI of the item that was picked.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800718 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
719 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
721 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800722 * (value: ShortcutIconResource).</p>
723 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800724 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700725 * @see #EXTRA_SHORTCUT_INTENT
726 * @see #EXTRA_SHORTCUT_NAME
727 * @see #EXTRA_SHORTCUT_ICON
728 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
729 * @see android.content.Intent.ShortcutIconResource
730 */
731 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
732 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
733
734 /**
735 * The name of the extra used to define the Intent of a shortcut.
736 *
737 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800738 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700739 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800740 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700741 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
742 /**
743 * The name of the extra used to define the name of a shortcut.
744 *
745 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800746 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700747 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800748 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700749 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
750 /**
751 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
752 *
753 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800754 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700755 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800756 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700757 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
758 /**
759 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
760 *
761 * @see #ACTION_CREATE_SHORTCUT
762 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800763 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700764 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800765 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700766 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
767 "android.intent.extra.shortcut.ICON_RESOURCE";
768
769 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500770 * An activity that provides a user interface for adjusting application preferences.
771 * Optional but recommended settings for all applications which have settings.
772 */
773 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
774 public static final String ACTION_APPLICATION_PREFERENCES
775 = "android.intent.action.APPLICATION_PREFERENCES";
776
777 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700778 * Activity Action: Launch an activity showing the app information.
779 * For applications which install other applications (such as app stores), it is recommended
780 * to handle this action for providing the app information to the user.
781 *
782 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
783 * to be displayed.
784 * <p>Output: Nothing.
785 */
786 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
787 public static final String ACTION_SHOW_APP_INFO
788 = "android.intent.action.SHOW_APP_INFO";
789
790 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800791 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700792 *
793 * @see Intent#ACTION_CREATE_SHORTCUT
794 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800795 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
796 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700797 */
798 public static class ShortcutIconResource implements Parcelable {
799 /**
800 * The package name of the application containing the icon.
801 */
802 public String packageName;
803
804 /**
805 * The resource name of the icon, including package, name and type.
806 */
807 public String resourceName;
808
809 /**
810 * Creates a new ShortcutIconResource for the specified context and resource
811 * identifier.
812 *
813 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700814 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700815 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700816 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700817 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700818 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700819 ShortcutIconResource icon = new ShortcutIconResource();
820 icon.packageName = context.getPackageName();
821 icon.resourceName = context.getResources().getResourceName(resourceId);
822 return icon;
823 }
824
825 /**
826 * Used to read a ShortcutIconResource from a Parcel.
827 */
828 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
829 new Parcelable.Creator<ShortcutIconResource>() {
830
831 public ShortcutIconResource createFromParcel(Parcel source) {
832 ShortcutIconResource icon = new ShortcutIconResource();
833 icon.packageName = source.readString();
834 icon.resourceName = source.readString();
835 return icon;
836 }
837
838 public ShortcutIconResource[] newArray(int size) {
839 return new ShortcutIconResource[size];
840 }
841 };
842
843 /**
844 * No special parcel contents.
845 */
846 public int describeContents() {
847 return 0;
848 }
849
850 public void writeToParcel(Parcel dest, int flags) {
851 dest.writeString(packageName);
852 dest.writeString(resourceName);
853 }
854
855 @Override
856 public String toString() {
857 return resourceName;
858 }
859 }
860
861 /**
862 * Activity Action: Display an activity chooser, allowing the user to pick
863 * what they want to before proceeding. This can be used as an alternative
864 * to the standard activity picker that is displayed by the system when
865 * you try to start an activity with multiple possible matches, with these
866 * differences in behavior:
867 * <ul>
868 * <li>You can specify the title that will appear in the activity chooser.
869 * <li>The user does not have the option to make one of the matching
870 * activities a preferred activity, and all possible activities will
871 * always be shown even if one of them is currently marked as the
872 * preferred activity.
873 * </ul>
874 * <p>
875 * This action should be used when the user will naturally expect to
876 * select an activity in order to proceed. An example if when not to use
877 * it is when the user clicks on a "mailto:" link. They would naturally
878 * expect to go directly to their mail app, so startActivity() should be
879 * called directly: it will
880 * either launch the current preferred app, or put up a dialog allowing the
881 * user to pick an app to use and optionally marking that as preferred.
882 * <p>
883 * In contrast, if the user is selecting a menu item to send a picture
884 * they are viewing to someone else, there are many different things they
885 * may want to do at this point: send it through e-mail, upload it to a
886 * web service, etc. In this case the CHOOSER action should be used, to
887 * always present to the user a list of the things they can do, with a
888 * nice title given by the caller such as "Send this photo with:".
889 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700890 * If you need to grant URI permissions through a chooser, you must specify
891 * the permissions to be granted on the ACTION_CHOOSER Intent
892 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
893 * {@link #setClipData} to specify the URIs to be granted as well as
894 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
895 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
896 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700897 * As a convenience, an Intent of this form can be created with the
898 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700899 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700900 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700901 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
902 * and can optionally have a {@link #EXTRA_TITLE} field containing the
903 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700904 * <p>
905 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700906 */
907 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
908 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
909
910 /**
911 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
912 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700913 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
914 * target intent, also optionally supplying a title. If the target
915 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
916 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
917 * set in the returned chooser intent, with its ClipData set appropriately:
918 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500919 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700920 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700921 * @param target The Intent that the user will be selecting an activity
922 * to perform.
923 * @param title Optional title that will be displayed in the chooser.
924 * @return Return a new Intent object that you can hand to
925 * {@link Context#startActivity(Intent) Context.startActivity()} and
926 * related methods.
927 */
928 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700929 return createChooser(target, title, null);
930 }
931
932 /**
933 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
934 *
935 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
936 * target intent, also optionally supplying a title. If the target
937 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
938 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
939 * set in the returned chooser intent, with its ClipData set appropriately:
940 * either a direct reflection of {@link #getClipData()} if that is non-null,
941 * or a new ClipData built from {@link #getData()}.</p>
942 *
943 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
944 * when the user makes a choice. This can be useful if the calling application wants
945 * to remember the last chosen target and surface it as a more prominent or one-touch
946 * affordance elsewhere in the UI for next time.</p>
947 *
948 * @param target The Intent that the user will be selecting an activity
949 * to perform.
950 * @param title Optional title that will be displayed in the chooser.
951 * @param sender Optional IntentSender to be called when a choice is made.
952 * @return Return a new Intent object that you can hand to
953 * {@link Context#startActivity(Intent) Context.startActivity()} and
954 * related methods.
955 */
956 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700957 Intent intent = new Intent(ACTION_CHOOSER);
958 intent.putExtra(EXTRA_INTENT, target);
959 if (title != null) {
960 intent.putExtra(EXTRA_TITLE, title);
961 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700962
Adam Powell0b3c1122014-10-09 12:50:14 -0700963 if (sender != null) {
964 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
965 }
966
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700967 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700968 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
969 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
970 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700971 if (permFlags != 0) {
972 ClipData targetClipData = target.getClipData();
973 if (targetClipData == null && target.getData() != null) {
974 ClipData.Item item = new ClipData.Item(target.getData());
975 String[] mimeTypes;
976 if (target.getType() != null) {
977 mimeTypes = new String[] { target.getType() };
978 } else {
979 mimeTypes = new String[] { };
980 }
981 targetClipData = new ClipData(null, mimeTypes, item);
982 }
983 if (targetClipData != null) {
984 intent.setClipData(targetClipData);
985 intent.addFlags(permFlags);
986 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700987 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700988
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700989 return intent;
990 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700991
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700992 /**
993 * Activity Action: Allow the user to select a particular kind of data and
994 * return it. This is different than {@link #ACTION_PICK} in that here we
995 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800996 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700997 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900998 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700999 * etc.
1000 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001001 * 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 -07001002 * of data, such as a person contact, you set the MIME type to the kind of
1003 * data you want and launch it with {@link Context#startActivity(Intent)}.
1004 * The system will then launch the best application to select that kind
1005 * of data for you.
1006 * <p>
1007 * You may also be interested in any of a set of types of content the user
1008 * can pick. For example, an e-mail application that wants to allow the
1009 * user to add an attachment to an e-mail message can use this action to
1010 * bring up a list of all of the types of content the user can attach.
1011 * <p>
1012 * In this case, you should wrap the GET_CONTENT intent with a chooser
1013 * (through {@link #createChooser}), which will give the proper interface
1014 * for the user to pick how to send your data and allow you to specify
1015 * a prompt indicating what they are doing. You will usually specify a
1016 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1017 * broad range of content types the user can select from.
1018 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001019 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001020 * only pick from data that can be represented as a stream. This is
1021 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1022 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001023 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001024 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001025 * is locally available on the device. For example, if this extra is set
1026 * to true then an image picker should not show any pictures that are available
1027 * from a remote server but not already on the local device (thus requiring
1028 * they be downloaded when opened).
1029 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001030 * If the caller can handle multiple returned items (the user performing
1031 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1032 * to indicate this.
1033 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001034 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1035 * that no URI is supplied in the intent, as there are no constraints on
1036 * where the returned data originally comes from. You may also include the
1037 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001038 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001039 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1040 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001041 * <p>
1042 * Output: The URI of the item that was picked. This must be a content:
1043 * URI so that any receiver can access it.
1044 */
1045 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1046 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1047 /**
1048 * Activity Action: Dial a number as specified by the data. This shows a
1049 * UI with the number being dialed, allowing the user to explicitly
1050 * initiate the call.
1051 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1052 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1053 * number.
1054 * <p>Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1058 /**
1059 * Activity Action: Perform a call to someone specified by the data.
1060 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1061 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1062 * number.
1063 * <p>Output: nothing.
1064 *
1065 * <p>Note: there will be restrictions on which applications can initiate a
1066 * call; most applications should use the {@link #ACTION_DIAL}.
1067 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1068 * numbers. Applications can <strong>dial</strong> emergency numbers using
1069 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001070 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001071 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001072 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001073 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001074 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001075 */
1076 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1077 public static final String ACTION_CALL = "android.intent.action.CALL";
1078 /**
1079 * Activity Action: Perform a call to an emergency number specified by the
1080 * data.
1081 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1082 * tel: URI of an explicit phone number.
1083 * <p>Output: nothing.
1084 * @hide
1085 */
1086 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1087 /**
1088 * Activity action: Perform a call to any number (emergency or not)
1089 * specified by the data.
1090 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1091 * tel: URI of an explicit phone number.
1092 * <p>Output: nothing.
1093 * @hide
1094 */
1095 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1096 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001097 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1098 * sending this intent is a no-op.
1099 * <p>Input: No data should be specified. get*Extra may have an optional
1100 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1101 * send the activation result.
1102 * <p>Output: nothing.
1103 * @hide
1104 */
1105 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1106 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1107 "android.intent.action.SIM_ACTIVATION_REQUEST";
1108 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001109 * Activity Action: Send a message to someone specified by the data.
1110 * <p>Input: {@link #getData} is URI describing the target.
1111 * <p>Output: nothing.
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1115 /**
1116 * Activity Action: Deliver some data to someone else. Who the data is
1117 * being delivered to is not specified; it is up to the receiver of this
1118 * action to ask the user where the data should be sent.
1119 * <p>
1120 * When launching a SEND intent, you should usually wrap it in a chooser
1121 * (through {@link #createChooser}), which will give the proper interface
1122 * for the user to pick how to send your data and allow you to specify
1123 * a prompt indicating what they are doing.
1124 * <p>
1125 * Input: {@link #getType} is the MIME type of the data being sent.
1126 * get*Extra can have either a {@link #EXTRA_TEXT}
1127 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1128 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1129 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1130 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001131 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1132 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1133 * your text with HTML formatting.
1134 * <p>
1135 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1136 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1137 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1138 * content: URIs and other advanced features of {@link ClipData}. If
1139 * using this approach, you still must supply the same data through the
1140 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1141 * for compatibility with old applications. If you don't set a ClipData,
1142 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001143 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001144 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1145 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1146 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1147 * be openable only as asset typed files using
1148 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1149 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001150 * Optional standard extras, which may be interpreted by some recipients as
1151 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1152 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1153 * <p>
1154 * Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_SEND = "android.intent.action.SEND";
1158 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001159 * Activity Action: Deliver multiple data to someone else.
1160 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001161 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001162 * <p>
1163 * Input: {@link #getType} is the MIME type of the data being sent.
1164 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001165 * #EXTRA_STREAM} field, containing the data to be sent. If using
1166 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1167 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001168 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001169 * Multiple types are supported, and receivers should handle mixed types
1170 * whenever possible. The right way for the receiver to check them is to
1171 * use the content resolver on each URI. The intent sender should try to
1172 * put the most concrete mime type in the intent type, but it can fall
1173 * back to {@literal <type>/*} or {@literal *}/* as needed.
1174 * <p>
1175 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1176 * be image/jpg, but if you are sending image/jpg and image/png, then the
1177 * intent's type should be image/*.
1178 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001179 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1180 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1181 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1182 * content: URIs and other advanced features of {@link ClipData}. If
1183 * using this approach, you still must supply the same data through the
1184 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1185 * for compatibility with old applications. If you don't set a ClipData,
1186 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1187 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001188 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1189 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1190 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1191 * be openable only as asset typed files using
1192 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1193 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001194 * Optional standard extras, which may be interpreted by some recipients as
1195 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1196 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1197 * <p>
1198 * Output: nothing.
1199 */
1200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1201 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1202 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001203 * Activity Action: Handle an incoming phone call.
1204 * <p>Input: nothing.
1205 * <p>Output: nothing.
1206 */
1207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1208 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1209 /**
1210 * Activity Action: Insert an empty item into the given container.
1211 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1212 * in which to place the data.
1213 * <p>Output: URI of the new data that was created.
1214 */
1215 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1216 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1217 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001218 * Activity Action: Create a new item in the given container, initializing it
1219 * from the current contents of the clipboard.
1220 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1221 * in which to place the data.
1222 * <p>Output: URI of the new data that was created.
1223 */
1224 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1225 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1226 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001227 * Activity Action: Delete the given data from its container.
1228 * <p>Input: {@link #getData} is URI of data to be deleted.
1229 * <p>Output: nothing.
1230 */
1231 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1232 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1233 /**
1234 * Activity Action: Run the data, whatever that means.
1235 * <p>Input: ? (Note: this is currently specific to the test harness.)
1236 * <p>Output: nothing.
1237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_RUN = "android.intent.action.RUN";
1240 /**
1241 * Activity Action: Perform a data synchronization.
1242 * <p>Input: ?
1243 * <p>Output: ?
1244 */
1245 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1246 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1247 /**
1248 * Activity Action: Pick an activity given an intent, returning the class
1249 * selected.
1250 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1251 * used with {@link PackageManager#queryIntentActivities} to determine the
1252 * set of activities from which to pick.
1253 * <p>Output: Class name of the activity that was selected.
1254 */
1255 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1256 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1257 /**
1258 * Activity Action: Perform a search.
1259 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1260 * is the text to search for. If empty, simply
1261 * enter your search results Activity with the search UI activated.
1262 * <p>Output: nothing.
1263 */
1264 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1265 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1266 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001267 * Activity Action: Start the platform-defined tutorial
1268 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1269 * is the text to search for. If empty, simply
1270 * enter your search results Activity with the search UI activated.
1271 * <p>Output: nothing.
1272 */
1273 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1274 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1275 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001276 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001277 * <p>
1278 * Input: {@link android.app.SearchManager#QUERY
1279 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1280 * a url starts with http or https, the site will be opened. If it is plain
1281 * text, Google search will be applied.
1282 * <p>
1283 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001284 */
1285 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1286 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001287
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001288 /**
Jim Miller07994402012-05-02 14:22:27 -07001289 * Activity Action: Perform assist action.
1290 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001291 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1292 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001293 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1294 * information.
Jim Miller07994402012-05-02 14:22:27 -07001295 * Output: nothing.
1296 */
1297 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1298 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001299
1300 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001301 * Activity Action: Perform voice assist action.
1302 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001303 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1304 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001305 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001306 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001307 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001308 */
1309 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1310 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1311
1312 /**
Adam Skory7140a252013-09-11 12:04:58 +01001313 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1314 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001315 */
1316 public static final String EXTRA_ASSIST_PACKAGE
1317 = "android.intent.extra.ASSIST_PACKAGE";
1318
1319 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001320 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1321 * application package at the time the assist was invoked.
1322 */
1323 public static final String EXTRA_ASSIST_UID
1324 = "android.intent.extra.ASSIST_UID";
1325
1326 /**
Adam Skory7140a252013-09-11 12:04:58 +01001327 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1328 * information supplied by the current foreground app at the time of the assist request.
1329 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001330 */
1331 public static final String EXTRA_ASSIST_CONTEXT
1332 = "android.intent.extra.ASSIST_CONTEXT";
1333
Jim Miller07994402012-05-02 14:22:27 -07001334 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001335 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1336 * keyboard as the primary input device for assistance.
1337 */
1338 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1339 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1340
1341 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001342 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1343 * that was used to invoke the assist.
1344 */
1345 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1346 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1347
1348 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001349 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001350 * <p>Input: Nothing.
1351 * <p>Output: nothing.
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1355 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001356 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001357 * <p>Input: Nothing.
1358 * <p>Output: Nothing.
1359 */
1360 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1361 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1362
1363 /**
1364 * Activity Action: Show activity for reporting a bug.
1365 * <p>Input: Nothing.
1366 * <p>Output: Nothing.
1367 */
1368 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1369 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1370
1371 /**
1372 * Activity Action: Main entry point for factory tests. Only used when
1373 * the device is booting in factory test node. The implementing package
1374 * must be installed in the system image.
1375 * <p>Input: nothing
1376 * <p>Output: nothing
1377 */
1378 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1379
1380 /**
1381 * Activity Action: The user pressed the "call" button to go to the dialer
1382 * or other appropriate UI for placing a call.
1383 * <p>Input: Nothing.
1384 * <p>Output: Nothing.
1385 */
1386 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1387 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1388
1389 /**
1390 * Activity Action: Start Voice Command.
1391 * <p>Input: Nothing.
1392 * <p>Output: Nothing.
1393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001396
1397 /**
1398 * Activity Action: Start action associated with long pressing on the
1399 * search key.
1400 * <p>Input: Nothing.
1401 * <p>Output: Nothing.
1402 */
1403 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1404 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001405
Jacek Surazski86b6c532009-05-13 14:38:28 +02001406 /**
1407 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1408 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001409 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001410 * <p>Input: No data is specified. The bug report is passed in using
1411 * an {@link #EXTRA_BUG_REPORT} field.
1412 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001413 *
1414 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001415 */
1416 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1417 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001418
1419 /**
1420 * Activity Action: Show power usage information to the user.
1421 * <p>Input: Nothing.
1422 * <p>Output: Nothing.
1423 */
1424 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1425 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001426
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001427 /**
1428 * Activity Action: Setup wizard to launch after a platform update. This
1429 * activity should have a string meta-data field associated with it,
1430 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1431 * the platform for setup. The activity will be launched only if
1432 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1433 * same value.
1434 * <p>Input: Nothing.
1435 * <p>Output: Nothing.
1436 * @hide
1437 */
1438 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1439 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001440
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001441 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001442 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1443 * <p>Input: Nothing.
1444 * <p>Output: Nothing.
1445 * @hide
1446 */
1447 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1448 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1449 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1450
1451 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001452 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1453 * <p>Input: Nothing.
1454 * <p>Output: Nothing.
1455 * @hide
1456 */
1457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1458 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1459 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1460
1461 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001462 * Activity Action: Show settings for managing network data usage of a
1463 * specific application. Applications should define an activity that offers
1464 * options to control data usage.
1465 */
1466 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1467 public static final String ACTION_MANAGE_NETWORK_USAGE =
1468 "android.intent.action.MANAGE_NETWORK_USAGE";
1469
1470 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001471 * Activity Action: Launch application installer.
1472 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001473 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001474 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1475 * you can also use "package:<package-name>" to install an application for the
1476 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001477 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1478 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1479 * <p>
1480 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1481 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001482 * <p>
1483 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1484 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1485 * in order to launch the application installer.
1486 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001487 *
1488 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1489 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1490 * @see #EXTRA_RETURN_RESULT
1491 */
1492 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1493 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1494
1495 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001496 * Activity Action: Launch ephemeral installer.
1497 * <p>
1498 * Input: The data must be a http: URI that the ephemeral application is registered
1499 * to handle.
1500 * <p class="note">
1501 * This is a protected intent that can only be sent by the system.
1502 * </p>
1503 *
1504 * @hide
1505 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001506 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1507 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1508 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1509
1510 /**
1511 * Service Action: Resolve ephemeral application.
1512 * <p>
1513 * The system will have a persistent connection to this service.
1514 * This is a protected intent that can only be sent by the system.
1515 * </p>
1516 *
1517 * @hide
1518 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001519 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1520 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1521 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1522
1523 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001524 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1525 * package. Specifies the installer package name; this package will receive the
1526 * {@link #ACTION_APP_ERROR} intent.
1527 */
1528 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1529 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1530
1531 /**
1532 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1533 * package. Specifies that the application being installed should not be
1534 * treated as coming from an unknown source, but as coming from the app
1535 * invoking the Intent. For this to work you must start the installer with
1536 * startActivityForResult().
1537 */
1538 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1539 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1540
1541 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001542 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1543 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001544 * data field originated from.
1545 */
rich cannings706e8ba2012-08-20 13:20:14 -07001546 public static final String EXTRA_ORIGINATING_URI
1547 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001548
1549 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001550 * This extra can be used with any Intent used to launch an activity, supplying information
1551 * about who is launching that activity. This field contains a {@link android.net.Uri}
1552 * object, typically an http: or https: URI of the web site that the referral came from;
1553 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1554 * a native application that it came from.
1555 *
1556 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1557 * instead of directly retrieving the extra. It is also valid for applications to
1558 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1559 * a string, not a Uri; the field here, if supplied, will always take precedence,
1560 * however.</p>
1561 *
1562 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001563 */
1564 public static final String EXTRA_REFERRER
1565 = "android.intent.extra.REFERRER";
1566
1567 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001568 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1569 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1570 * not be created, in particular when Intent extras are supplied through the
1571 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1572 * schemes.
1573 *
1574 * @see #EXTRA_REFERRER
1575 */
1576 public static final String EXTRA_REFERRER_NAME
1577 = "android.intent.extra.REFERRER_NAME";
1578
1579 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001580 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001581 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001582 * @hide
1583 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001584 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001585 public static final String EXTRA_ORIGINATING_UID
1586 = "android.intent.extra.ORIGINATING_UID";
1587
1588 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001589 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1590 * package. Tells the installer UI to skip the confirmation with the user
1591 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001592 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1593 * will no longer show an interstitial message about updating existing
1594 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001595 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001596 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001597 public static final String EXTRA_ALLOW_REPLACE
1598 = "android.intent.extra.ALLOW_REPLACE";
1599
1600 /**
1601 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1602 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1603 * return to the application the result code of the install/uninstall. The returned result
1604 * code will be {@link android.app.Activity#RESULT_OK} on success or
1605 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1606 */
1607 public static final String EXTRA_RETURN_RESULT
1608 = "android.intent.extra.RETURN_RESULT";
1609
1610 /**
1611 * Package manager install result code. @hide because result codes are not
1612 * yet ready to be exposed.
1613 */
1614 public static final String EXTRA_INSTALL_RESULT
1615 = "android.intent.extra.INSTALL_RESULT";
1616
1617 /**
1618 * Activity Action: Launch application uninstaller.
1619 * <p>
1620 * Input: The data must be a package: URI whose scheme specific part is
1621 * the package name of the current installed package to be uninstalled.
1622 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1623 * <p>
1624 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1625 * succeeded.
1626 */
1627 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1628 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1629
1630 /**
msnider3c191b82017-01-23 14:23:16 -08001631 * Activity Action: Launch application uninstaller.
1632 * <p>
1633 * Input: The data must be a package: URI whose scheme specific part is
1634 * the package name of the current installed package to be uninstalled.
1635 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1636 * <p>
1637 * Output: Nothing.
1638 * </p>
1639 */
1640 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1641 public static final String ACTION_CLEAR_PACKAGE = "android.intent.action.CLEAR_PACKAGE";
1642
1643 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001644 * Specify whether the package should be uninstalled for all users.
1645 * @hide because these should not be part of normal application flow.
1646 */
1647 public static final String EXTRA_UNINSTALL_ALL_USERS
1648 = "android.intent.extra.UNINSTALL_ALL_USERS";
1649
1650 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001651 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1652 * describing the last run version of the platform that was setup.
1653 * @hide
1654 */
1655 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1656
Svet Ganov3695b8a2015-03-24 16:30:25 -07001657 /**
1658 * Activity action: Launch UI to manage the permissions of an app.
1659 * <p>
1660 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1661 * will be managed by the launched UI.
1662 * </p>
1663 * <p>
1664 * Output: Nothing.
1665 * </p>
1666 *
1667 * @see #EXTRA_PACKAGE_NAME
1668 *
1669 * @hide
1670 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001671 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001672 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1673 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1674 "android.intent.action.MANAGE_APP_PERMISSIONS";
1675
1676 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001677 * Activity action: Launch UI to manage permissions.
1678 * <p>
1679 * Input: Nothing.
1680 * </p>
1681 * <p>
1682 * Output: Nothing.
1683 * </p>
1684 *
1685 * @hide
1686 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001687 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001688 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1689 public static final String ACTION_MANAGE_PERMISSIONS =
1690 "android.intent.action.MANAGE_PERMISSIONS";
1691
1692 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001693 * Activity action: Launch UI to review permissions for an app.
1694 * The system uses this intent if permission review for apps not
1695 * supporting the new runtime permissions model is enabled. In
1696 * this mode a permission review is required before any of the
1697 * app components can run.
1698 * <p>
1699 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1700 * permissions will be reviewed (mandatory).
1701 * </p>
1702 * <p>
1703 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1704 * be fired after the permission review (optional).
1705 * </p>
1706 * <p>
1707 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1708 * be invoked after the permission review (optional).
1709 * </p>
1710 * <p>
1711 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1712 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1713 * </p>
1714 * <p>
1715 * Output: Nothing.
1716 * </p>
1717 *
1718 * @see #EXTRA_PACKAGE_NAME
1719 * @see #EXTRA_INTENT
1720 * @see #EXTRA_REMOTE_CALLBACK
1721 * @see #EXTRA_RESULT_NEEDED
1722 *
1723 * @hide
1724 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001725 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001726 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1727 public static final String ACTION_REVIEW_PERMISSIONS =
1728 "android.intent.action.REVIEW_PERMISSIONS";
1729
1730 /**
1731 * Intent extra: A callback for reporting remote result as a bundle.
1732 * <p>
1733 * Type: IRemoteCallback
1734 * </p>
1735 *
1736 * @hide
1737 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001738 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001739 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1740
1741 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001742 * Intent extra: An app package name.
1743 * <p>
1744 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001745 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001746 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001747 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001748 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1749
1750 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001751 * Intent extra: An app split name.
1752 * <p>
1753 * Type: String
1754 * </p>
1755 * @hide
1756 */
1757 @SystemApi
1758 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1759
1760 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001761 * Intent extra: An extra for specifying whether a result is needed.
1762 * <p>
1763 * Type: boolean
1764 * </p>
1765 *
1766 * @hide
1767 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001768 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001769 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1770
1771 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001772 * Activity action: Launch UI to manage which apps have a given permission.
1773 * <p>
1774 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1775 * to which will be managed by the launched UI.
1776 * </p>
1777 * <p>
1778 * Output: Nothing.
1779 * </p>
1780 *
1781 * @see #EXTRA_PERMISSION_NAME
1782 *
1783 * @hide
1784 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001785 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001786 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1787 public static final String ACTION_MANAGE_PERMISSION_APPS =
1788 "android.intent.action.MANAGE_PERMISSION_APPS";
1789
1790 /**
1791 * Intent extra: The name of a permission.
1792 * <p>
1793 * Type: String
1794 * </p>
1795 *
1796 * @hide
1797 */
1798 @SystemApi
1799 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1800
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001801 // ---------------------------------------------------------------------
1802 // ---------------------------------------------------------------------
1803 // Standard intent broadcast actions (see action variable).
1804
1805 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001806 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1807 * <p>
1808 * For historical reasons, the name of this broadcast action refers to the power
1809 * state of the screen but it is actually sent in response to changes in the
1810 * overall interactive state of the device.
1811 * </p><p>
1812 * This broadcast is sent when the device becomes non-interactive which may have
1813 * nothing to do with the screen turning off. To determine the
1814 * actual state of the screen, use {@link android.view.Display#getState}.
1815 * </p><p>
1816 * See {@link android.os.PowerManager#isInteractive} for details.
1817 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001818 * You <em>cannot</em> receive this through components declared in
1819 * manifests, only by explicitly registering for it with
1820 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1821 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001822 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001823 * <p class="note">This is a protected intent that can only be sent
1824 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001825 */
1826 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1827 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001828
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001829 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001830 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1831 * <p>
1832 * For historical reasons, the name of this broadcast action refers to the power
1833 * state of the screen but it is actually sent in response to changes in the
1834 * overall interactive state of the device.
1835 * </p><p>
1836 * This broadcast is sent when the device becomes interactive which may have
1837 * nothing to do with the screen turning on. To determine the
1838 * actual state of the screen, use {@link android.view.Display#getState}.
1839 * </p><p>
1840 * See {@link android.os.PowerManager#isInteractive} for details.
1841 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001842 * You <em>cannot</em> receive this through components declared in
1843 * manifests, only by explicitly registering for it with
1844 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1845 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001846 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001847 * <p class="note">This is a protected intent that can only be sent
1848 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 */
1850 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1851 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001852
1853 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001854 * Broadcast Action: Sent after the system stops dreaming.
1855 *
1856 * <p class="note">This is a protected intent that can only be sent by the system.
1857 * It is only sent to registered receivers.</p>
1858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1861
1862 /**
1863 * Broadcast Action: Sent after the system starts dreaming.
1864 *
1865 * <p class="note">This is a protected intent that can only be sent by the system.
1866 * It is only sent to registered receivers.</p>
1867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1870
1871 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001872 * 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 -07001873 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001874 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001875 * <p class="note">This is a protected intent that can only be sent
1876 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001877 */
1878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001879 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001880
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 /**
1882 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001883 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001884 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001885 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1886 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001887 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001888 * <p class="note">This is a protected intent that can only be sent
1889 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001890 */
1891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1892 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1893 /**
1894 * Broadcast Action: The time was set.
1895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1898 /**
1899 * Broadcast Action: The date has changed.
1900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1902 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1903 /**
1904 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1905 * <ul>
1906 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1907 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001908 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001909 * <p class="note">This is a protected intent that can only be sent
1910 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911 */
1912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1913 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1914 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001915 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1916 * DNS entries should be tossed.
1917 * @hide
1918 */
1919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1920 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1921 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001922 * Alarm Changed Action: This is broadcast when the AlarmClock
1923 * application's alarm is set or unset. It is used by the
1924 * AlarmClock application and the StatusBar service.
1925 * @hide
1926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001929
1930 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001931 * Broadcast Action: This is broadcast once, after the user has finished
1932 * booting, but while still in the "locked" state. It can be used to perform
1933 * application-specific initialization, such as installing alarms. You must
1934 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1935 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001936 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001937 * This broadcast is sent immediately at boot by all devices (regardless of
1938 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1939 * higher. Upon receipt of this broadcast, the user is still locked and only
1940 * device-protected storage can be accessed safely. If you want to access
1941 * credential-protected storage, you need to wait for the user to be
1942 * unlocked (typically by entering their lock pattern or PIN for the first
1943 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1944 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1945 * <p>
1946 * To receive this broadcast, your receiver component must be marked as
1947 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001948 * <p class="note">
1949 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001950 *
1951 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001952 */
1953 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1954 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1955
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001957 * Broadcast Action: This is broadcast once, after the user has finished
1958 * booting. It can be used to perform application-specific initialization,
1959 * such as installing alarms. You must hold the
1960 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1961 * order to receive this broadcast.
1962 * <p>
1963 * This broadcast is sent at boot by all devices (both with and without
1964 * direct boot support). Upon receipt of this broadcast, the user is
1965 * unlocked and both device-protected and credential-protected storage can
1966 * accessed safely.
1967 * <p>
1968 * If you need to run while the user is still locked (before they've entered
1969 * their lock pattern or PIN for the first time), you can listen for the
1970 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1971 * <p class="note">
1972 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001976
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 /**
1978 * Broadcast Action: This is broadcast when a user action should request a
1979 * temporary system dialog to dismiss. Some examples of temporary system
1980 * dialogs are the notification window-shade and the recent tasks dialog.
1981 */
1982 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1983 /**
1984 * Broadcast Action: Trigger the download and eventual installation
1985 * of a package.
1986 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001987 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001988 * <p class="note">This is a protected intent that can only be sent
1989 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001990 *
1991 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001993 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1996 /**
1997 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001998 * device. The data contains the name of the package. Note that the
1999 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002000 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002001 * <ul>
2002 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2003 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2004 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2005 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002006 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002007 * <p class="note">This is a protected intent that can only be sent
2008 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2012 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002013 * Broadcast Action: A new version of an application package has been
2014 * installed, replacing an existing version that was previously installed.
2015 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002016 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002017 * <ul>
2018 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2019 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002020 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002021 * <p class="note">This is a protected intent that can only be sent
2022 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2026 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002027 * Broadcast Action: A new version of your application has been installed
2028 * over an existing one. This is only sent to the application that was
2029 * replaced. It does not contain any additional data; to receive it, just
2030 * use an intent filter for this action.
2031 *
2032 * <p class="note">This is a protected intent that can only be sent
2033 * by the system.
2034 */
2035 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2036 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2037 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002038 * Broadcast Action: An existing application package has been removed from
2039 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002040 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002041 * <ul>
2042 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2043 * to the package.
2044 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2045 * application -- data and code -- is being removed.
2046 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2047 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2048 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002049 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002050 * <p class="note">This is a protected intent that can only be sent
2051 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2055 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002056 * Broadcast Action: An existing application package has been completely
2057 * removed from the device. The data contains the name of the package.
2058 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2059 * {@link #EXTRA_DATA_REMOVED} is true and
2060 * {@link #EXTRA_REPLACING} is false of that broadcast.
2061 *
2062 * <ul>
2063 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2064 * to the package.
2065 * </ul>
2066 *
2067 * <p class="note">This is a protected intent that can only be sent
2068 * by the system.
2069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_PACKAGE_FULLY_REMOVED
2072 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2073 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002074 * Broadcast Action: An existing application package has been changed (for
2075 * example, a component has been enabled or disabled). The data contains
2076 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002077 * <ul>
2078 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002079 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002080 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002081 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2082 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002083 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002084 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002085 * <p class="note">This is a protected intent that can only be sent
2086 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002087 */
2088 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2089 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2090 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002091 * @hide
2092 * Broadcast Action: Ask system services if there is any reason to
2093 * restart the given package. The data contains the name of the
2094 * package.
2095 * <ul>
2096 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2097 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2098 * </ul>
2099 *
2100 * <p class="note">This is a protected intent that can only be sent
2101 * by the system.
2102 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002103 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002104 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2105 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2106 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002107 * Broadcast Action: The user has restarted a package, and all of its
2108 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002109 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002110 * be removed. Note that the restarted package does <em>not</em>
2111 * receive this broadcast.
2112 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002113 * <ul>
2114 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2115 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002116 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002117 * <p class="note">This is a protected intent that can only be sent
2118 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002119 */
2120 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2121 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2122 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002123 * Broadcast Action: The user has cleared the data of a package. This should
2124 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002125 * its persistent data is erased and this broadcast sent.
2126 * Note that the cleared package does <em>not</em>
2127 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002128 * <ul>
2129 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2130 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002131 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002132 * <p class="note">This is a protected intent that can only be sent
2133 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2137 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002138 * Broadcast Action: Packages have been suspended.
2139 * <p>Includes the following extras:
2140 * <ul>
2141 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2142 * </ul>
2143 *
2144 * <p class="note">This is a protected intent that can only be sent
2145 * by the system. It is only sent to registered receivers.
2146 */
2147 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2148 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2149 /**
2150 * Broadcast Action: Packages have been unsuspended.
2151 * <p>Includes the following extras:
2152 * <ul>
2153 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2154 * </ul>
2155 *
2156 * <p class="note">This is a protected intent that can only be sent
2157 * by the system. It is only sent to registered receivers.
2158 */
2159 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2160 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2161 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002162 * Broadcast Action: A user ID has been removed from the system. The user
2163 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002164 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002165 * <p class="note">This is a protected intent that can only be sent
2166 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002167 */
2168 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2169 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002170
2171 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002172 * Broadcast Action: Sent to the installer package of an application when
2173 * that application is first launched (that is the first time it is moved
2174 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002175 *
2176 * <p class="note">This is a protected intent that can only be sent
2177 * by the system.
2178 */
2179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2180 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2181
2182 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002183 * Broadcast Action: Sent to the system package verifier when a package
2184 * needs to be verified. The data contains the package URI.
2185 * <p class="note">
2186 * This is a protected intent that can only be sent by the system.
2187 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002188 */
2189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2190 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2191
2192 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002193 * Broadcast Action: Sent to the system package verifier when a package is
2194 * verified. The data contains the package URI.
2195 * <p class="note">
2196 * This is a protected intent that can only be sent by the system.
2197 */
2198 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2199 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2200
2201 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002202 * Broadcast Action: Sent to the system intent filter verifier when an
2203 * intent filter needs to be verified. The data contains the filter data
2204 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002205 * <p class="note">
2206 * This is a protected intent that can only be sent by the system.
2207 * </p>
2208 *
2209 * @hide
2210 */
2211 @SystemApi
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2214
2215 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002216 * Broadcast Action: Resources for a set of packages (which were
2217 * previously unavailable) are currently
2218 * available since the media on which they exist is available.
2219 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2220 * list of packages whose availability changed.
2221 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2222 * list of uids of packages whose availability changed.
2223 * Note that the
2224 * packages in this list do <em>not</em> receive this broadcast.
2225 * The specified set of packages are now available on the system.
2226 * <p>Includes the following extras:
2227 * <ul>
2228 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2229 * whose resources(were previously unavailable) are currently available.
2230 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2231 * packages whose resources(were previously unavailable)
2232 * are currently available.
2233 * </ul>
2234 *
2235 * <p class="note">This is a protected intent that can only be sent
2236 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002237 */
2238 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002239 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2240 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002241
2242 /**
2243 * Broadcast Action: Resources for a set of packages are currently
2244 * unavailable since the media on which they exist is unavailable.
2245 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2246 * list of packages whose availability changed.
2247 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2248 * list of uids of packages whose availability changed.
2249 * The specified set of packages can no longer be
2250 * launched and are practically unavailable on the system.
2251 * <p>Inclues the following extras:
2252 * <ul>
2253 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2254 * whose resources are no longer available.
2255 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2256 * whose resources are no longer available.
2257 * </ul>
2258 *
2259 * <p class="note">This is a protected intent that can only be sent
2260 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002261 */
2262 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002263 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002264 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002265
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002266 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002267 * Broadcast Action: preferred activities have changed *explicitly*.
2268 *
2269 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2270 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2271 * be sent.
2272 *
2273 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2274 *
2275 * @hide
2276 */
2277 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2278 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2279 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2280
2281
2282 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002283 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002284 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002285 * This should <em>only</em> be used to determine when the wallpaper
2286 * has changed to show the new wallpaper to the user. You should certainly
2287 * never, in response to this, change the wallpaper or other attributes of
2288 * it such as the suggested size. That would be crazy, right? You'd cause
2289 * all kinds of loops, especially if other apps are doing similar things,
2290 * right? Of course. So please don't do this.
2291 *
2292 * @deprecated Modern applications should use
2293 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2294 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2295 * shown behind their UI, rather than watching for this broadcast and
2296 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002297 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002298 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002299 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2300 /**
2301 * Broadcast Action: The current device {@link android.content.res.Configuration}
2302 * (orientation, locale, etc) has changed. When such a change happens, the
2303 * UIs (view hierarchy) will need to be rebuilt based on this new
2304 * information; for the most part, applications don't need to worry about
2305 * this, because the system will take care of stopping and restarting the
2306 * application to make sure it sees the new changes. Some system code that
2307 * can not be restarted will need to watch for this action and handle it
2308 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002309 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002310 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002311 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002312 * in manifests, only by explicitly registering for it with
2313 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2314 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002315 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002316 * <p class="note">This is a protected intent that can only be sent
2317 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002318 *
2319 * @see android.content.res.Configuration
2320 */
2321 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2322 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2323 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002324 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002325 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002326 * <p class="note">This is a protected intent that can only be sent
2327 * by the system.
2328 */
2329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2330 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2331 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002332 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2333 * charging state, level, and other information about the battery.
2334 * See {@link android.os.BatteryManager} for documentation on the
2335 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002336 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002337 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002338 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002339 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002340 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002341 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2342 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2343 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2344 * broadcasts that are sent and can be received through manifest
2345 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002346 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002347 * <p class="note">This is a protected intent that can only be sent
2348 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002349 */
2350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2351 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2352 /**
2353 * Broadcast Action: Indicates low battery condition on the device.
2354 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002355 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002356 * <p class="note">This is a protected intent that can only be sent
2357 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002358 */
2359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2360 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2361 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002362 * Broadcast Action: Indicates the battery is now okay after being low.
2363 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2364 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002365 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002366 * <p class="note">This is a protected intent that can only be sent
2367 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002368 */
2369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2370 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2371 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002372 * Broadcast Action: External power has been connected to the device.
2373 * This is intended for applications that wish to register specifically to this notification.
2374 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2375 * stay active to receive this notification. This action can be used to implement actions
2376 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002378 * <p class="note">This is a protected intent that can only be sent
2379 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002380 */
2381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002382 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002383 /**
2384 * Broadcast Action: External power has been removed from the device.
2385 * This is intended for applications that wish to register specifically to this notification.
2386 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2387 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002388 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002389 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002390 * <p class="note">This is a protected intent that can only be sent
2391 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002392 */
2393 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002394 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002395 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002396 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002397 * Broadcast Action: Device is shutting down.
2398 * This is broadcast when the device is being shut down (completely turned
2399 * off, not sleeping). Once the broadcast is complete, the final shutdown
2400 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002401 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002402 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002403 * <p class="note">This is a protected intent that can only be sent
2404 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002405 * <p>May include the following extras:
2406 * <ul>
2407 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2408 * shutdown is only for userspace processes. If not set, assumed to be false.
2409 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002410 */
2411 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002412 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002413 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002414 * Activity Action: Start this activity to request system shutdown.
2415 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002416 * to request confirmation from the user before shutting down. The optional boolean
2417 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2418 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002419 *
2420 * <p class="note">This is a protected intent that can only be sent
2421 * by the system.
2422 *
2423 * {@hide}
2424 */
2425 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2426 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002427 * Broadcast Action: A sticky broadcast that indicates low memory
2428 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002429 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002430 * <p class="note">This is a protected intent that can only be sent
2431 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002432 */
2433 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2434 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2435 /**
2436 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002437 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002438 * <p class="note">This is a protected intent that can only be sent
2439 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002440 */
2441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2442 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2443 /**
Jake Hambybb371632010-08-23 18:16:48 -07002444 * Broadcast Action: A sticky broadcast that indicates a memory full
2445 * condition on the device. This is intended for activities that want
2446 * to be able to fill the data partition completely, leaving only
2447 * enough free space to prevent system-wide SQLite failures.
2448 *
2449 * <p class="note">This is a protected intent that can only be sent
2450 * by the system.
2451 *
2452 * {@hide}
2453 */
2454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2455 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2456 /**
2457 * Broadcast Action: Indicates memory full condition on the device
2458 * no longer exists.
2459 *
2460 * <p class="note">This is a protected intent that can only be sent
2461 * by the system.
2462 *
2463 * {@hide}
2464 */
2465 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2466 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2467 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002468 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2469 * and package management should be started.
2470 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2471 * notification.
2472 */
2473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2474 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2475 /**
2476 * Broadcast Action: The device has entered USB Mass Storage mode.
2477 * This is used mainly for the USB Settings panel.
2478 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2479 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002480 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002481 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002482 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002483 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2484
2485 /**
2486 * Broadcast Action: The device has exited USB Mass Storage mode.
2487 * This is used mainly for the USB Settings panel.
2488 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2489 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002490 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002491 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002492 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002493 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2494
2495 /**
2496 * Broadcast Action: External media has been removed.
2497 * The path to the mount point for the removed media is contained in the Intent.mData field.
2498 */
2499 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2500 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2501
2502 /**
2503 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002504 * 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 -07002505 */
2506 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2507 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2508
2509 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002510 * Broadcast Action: External media is present, and being disk-checked
2511 * 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 -08002512 */
2513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2514 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2515
2516 /**
2517 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2518 * 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 -08002519 */
2520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2521 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2522
2523 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002524 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002525 * 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 -07002526 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2527 * media was mounted read only.
2528 */
2529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2530 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2531
2532 /**
2533 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002534 * 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 -07002535 */
2536 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2537 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2538
2539 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002540 * Broadcast Action: External media is no longer being shared via USB mass storage.
2541 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2542 *
2543 * @hide
2544 */
2545 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2546
2547 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002548 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2549 * The path to the mount point for the removed media is contained in the Intent.mData field.
2550 */
2551 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2552 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2553
2554 /**
2555 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002556 * 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 -07002557 */
2558 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2559 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2560
2561 /**
2562 * Broadcast Action: User has expressed the desire to remove the external storage media.
2563 * Applications should close all files they have open within the mount point when they receive this intent.
2564 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2565 */
2566 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2567 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2568
2569 /**
2570 * Broadcast Action: The media scanner has started scanning a directory.
2571 * The path to the directory being scanned is contained in the Intent.mData field.
2572 */
2573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2574 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2575
2576 /**
2577 * Broadcast Action: The media scanner has finished scanning a directory.
2578 * The path to the scanned directory is contained in the Intent.mData field.
2579 */
2580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2581 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2582
2583 /**
2584 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2585 * The path to the file is contained in the Intent.mData field.
2586 */
2587 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2588 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2589
2590 /**
2591 * Broadcast Action: The "Media Button" was pressed. Includes a single
2592 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2593 * caused the broadcast.
2594 */
2595 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2596 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2597
2598 /**
2599 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2600 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2601 * caused the broadcast.
2602 */
2603 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2604 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2605
2606 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2607 // location; they are not general-purpose actions.
2608
2609 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002610 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002611 */
2612 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2613 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2614 "android.intent.action.GTALK_CONNECTED";
2615
2616 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002617 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002618 */
2619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2620 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2621 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002622
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002623 /**
2624 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002625 */
2626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2627 public static final String ACTION_INPUT_METHOD_CHANGED =
2628 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002629
2630 /**
2631 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2632 * more radios have been turned off or on. The intent will have the following extra value:</p>
2633 * <ul>
2634 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2635 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2636 * turned off</li>
2637 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002638 *
Peng Xua35b5532016-01-20 00:05:45 -08002639 * <p class="note">This is a protected intent that can only be sent by the system.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002640 */
2641 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2642 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2643
2644 /**
2645 * Broadcast Action: Some content providers have parts of their namespace
2646 * where they publish new events or items that the user may be especially
2647 * interested in. For these things, they may broadcast this action when the
2648 * set of interesting items change.
2649 *
2650 * For example, GmailProvider sends this notification when the set of unread
2651 * mail in the inbox changes.
2652 *
2653 * <p>The data of the intent identifies which part of which provider
2654 * changed. When queried through the content resolver, the data URI will
2655 * return the data set in question.
2656 *
2657 * <p>The intent will have the following extra values:
2658 * <ul>
2659 * <li><em>count</em> - The number of items in the data set. This is the
2660 * same as the number of items in the cursor returned by querying the
2661 * data URI. </li>
2662 * </ul>
2663 *
2664 * This intent will be sent at boot (if the count is non-zero) and when the
2665 * data set changes. It is possible for the data set to change without the
2666 * count changing (for example, if a new unread message arrives in the same
2667 * sync operation in which a message is archived). The phone should still
2668 * ring/vibrate/etc as normal in this case.
2669 */
2670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2671 public static final String ACTION_PROVIDER_CHANGED =
2672 "android.intent.action.PROVIDER_CHANGED";
2673
2674 /**
2675 * Broadcast Action: Wired Headset plugged in or unplugged.
2676 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002677 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2678 * and documentation.
2679 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002680 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002681 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002682 */
2683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002684 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002685
2686 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002687 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2688 * <ul>
2689 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2690 * </ul>
2691 *
2692 * <p class="note">This is a protected intent that can only be sent
2693 * by the system.
2694 *
2695 * @hide
2696 */
2697 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2698 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2699 = "android.intent.action.ADVANCED_SETTINGS";
2700
2701 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002702 * Broadcast Action: Sent after application restrictions are changed.
2703 *
2704 * <p class="note">This is a protected intent that can only be sent
2705 * by the system.</p>
2706 */
2707 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2708 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2709 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2710
2711 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002712 * Broadcast Action: An outgoing call is about to be placed.
2713 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002714 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002715 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002716 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002717 * the phone number originally intended to be dialed.</li>
2718 * </ul>
2719 * <p>Once the broadcast is finished, the resultData is used as the actual
2720 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002721 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002722 * outgoing call in turn: for example, a parental control application
2723 * might verify that the user is authorized to place the call at that
2724 * time, then a number-rewriting application might add an area code if
2725 * one was not specified.</p>
2726 * <p>For consistency, any receiver whose purpose is to prohibit phone
2727 * calls should have a priority of 0, to ensure it will see the final
2728 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002729 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002730 * should have a positive priority.
2731 * Negative priorities are reserved for the system for this broadcast;
2732 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002733 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2734 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002735 * <p>Emergency calls cannot be intercepted using this mechanism, and
2736 * other calls cannot be modified to call emergency numbers using this
2737 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002738 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2739 * call to use their own service instead. Those apps should first prevent
2740 * the call from being placed by setting resultData to <code>null</code>
2741 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002742 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002743 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2744 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002745 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002746 * <p class="note">This is a protected intent that can only be sent
2747 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002748 */
2749 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2750 public static final String ACTION_NEW_OUTGOING_CALL =
2751 "android.intent.action.NEW_OUTGOING_CALL";
2752
2753 /**
2754 * Broadcast Action: Have the device reboot. This is only for use by
2755 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002756 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002757 * <p class="note">This is a protected intent that can only be sent
2758 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002759 */
2760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2761 public static final String ACTION_REBOOT =
2762 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002763
Wei Huang97ecc9c2009-05-11 17:44:20 -07002764 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002765 * Broadcast Action: A sticky broadcast for changes in the physical
2766 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002767 *
2768 * <p>The intent will have the following extra values:
2769 * <ul>
2770 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002771 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002772 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002773 * <p>This is intended for monitoring the current physical dock state.
2774 * See {@link android.app.UiModeManager} for the normal API dealing with
2775 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002776 */
2777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2778 public static final String ACTION_DOCK_EVENT =
2779 "android.intent.action.DOCK_EVENT";
2780
2781 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002782 * Broadcast Action: A broadcast when idle maintenance can be started.
2783 * This means that the user is not interacting with the device and is
2784 * not expected to do so soon. Typical use of the idle maintenance is
2785 * to perform somehow expensive tasks that can be postponed at a moment
2786 * when they will not degrade user experience.
2787 * <p>
2788 * <p class="note">In order to keep the device responsive in case of an
2789 * unexpected user interaction, implementations of a maintenance task
2790 * should be interruptible. In such a scenario a broadcast with action
2791 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2792 * should not do the maintenance work in
2793 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2794 * maintenance service by {@link Context#startService(Intent)}. Also
2795 * you should hold a wake lock while your maintenance service is running
2796 * to prevent the device going to sleep.
2797 * </p>
2798 * <p>
2799 * <p class="note">This is a protected intent that can only be sent by
2800 * the system.
2801 * </p>
2802 *
2803 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002804 *
2805 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002806 */
2807 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2808 public static final String ACTION_IDLE_MAINTENANCE_START =
2809 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2810
2811 /**
2812 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2813 * This means that the user was not interacting with the device as a result
2814 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2815 * was sent and now the user started interacting with the device. Typical
2816 * use of the idle maintenance is to perform somehow expensive tasks that
2817 * can be postponed at a moment when they will not degrade user experience.
2818 * <p>
2819 * <p class="note">In order to keep the device responsive in case of an
2820 * unexpected user interaction, implementations of a maintenance task
2821 * should be interruptible. Hence, on receiving a broadcast with this
2822 * action, the maintenance task should be interrupted as soon as possible.
2823 * In other words, you should not do the maintenance work in
2824 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2825 * maintenance service that was started on receiving of
2826 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2827 * lock you acquired when your maintenance service started.
2828 * </p>
2829 * <p class="note">This is a protected intent that can only be sent
2830 * by the system.
2831 *
2832 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002833 *
2834 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002835 */
2836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2837 public static final String ACTION_IDLE_MAINTENANCE_END =
2838 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2839
2840 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002841 * Broadcast Action: a remote intent is to be broadcasted.
2842 *
2843 * A remote intent is used for remote RPC between devices. The remote intent
2844 * is serialized and sent from one device to another device. The receiving
2845 * device parses the remote intent and broadcasts it. Note that anyone can
2846 * broadcast a remote intent. However, if the intent receiver of the remote intent
2847 * does not trust intent broadcasts from arbitrary intent senders, it should require
2848 * the sender to hold certain permissions so only trusted sender's broadcast will be
2849 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002850 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002851 */
2852 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002853 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002854
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002855 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002856 * Broadcast Action: This is broadcast once when the user is booting after a
2857 * system update. It can be used to perform cleanup or upgrades after a
2858 * system update.
2859 * <p>
2860 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2861 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2862 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2863 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002864 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002865 * @hide
2866 */
2867 public static final String ACTION_PRE_BOOT_COMPLETED =
2868 "android.intent.action.PRE_BOOT_COMPLETED";
2869
Amith Yamasani13593602012-03-22 16:16:17 -07002870 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002871 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002872 * on restricted users. The broadcast intent contains an extra
2873 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2874 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2875 * String[] depending on the restriction type.<p/>
2876 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002877 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2878 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2879 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002880 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2881 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002882 * @see RestrictionEntry
2883 */
2884 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2885 "android.intent.action.GET_RESTRICTION_ENTRIES";
2886
2887 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002888 * Sent the first time a user is starting, to allow system apps to
2889 * perform one time initialization. (This will not be seen by third
2890 * party applications because a newly initialized user does not have any
2891 * third party applications installed for it.) This is sent early in
2892 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002893 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2894 * broadcast, since it is part of a visible user interaction; be as quick
2895 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002896 */
2897 public static final String ACTION_USER_INITIALIZE =
2898 "android.intent.action.USER_INITIALIZE";
2899
2900 /**
2901 * Sent when a user switch is happening, causing the process's user to be
2902 * brought to the foreground. This is only sent to receivers registered
2903 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2904 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002905 * foreground. This is sent as a foreground
2906 * broadcast, since it is part of a visible user interaction; be as quick
2907 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002908 */
2909 public static final String ACTION_USER_FOREGROUND =
2910 "android.intent.action.USER_FOREGROUND";
2911
2912 /**
2913 * Sent when a user switch is happening, causing the process's user to be
2914 * sent to the background. This is only sent to receivers registered
2915 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2916 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002917 * background. This is sent as a foreground
2918 * broadcast, since it is part of a visible user interaction; be as quick
2919 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002920 */
2921 public static final String ACTION_USER_BACKGROUND =
2922 "android.intent.action.USER_BACKGROUND";
2923
2924 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002925 * Broadcast sent to the system when a user is added. Carries an extra
2926 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2927 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002928 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002929 * @hide
2930 */
2931 public static final String ACTION_USER_ADDED =
2932 "android.intent.action.USER_ADDED";
2933
2934 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002935 * Broadcast sent by the system when a user is started. Carries an extra
2936 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002937 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002938 * that has been started. This is sent as a foreground
2939 * broadcast, since it is part of a visible user interaction; be as quick
2940 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002941 * @hide
2942 */
2943 public static final String ACTION_USER_STARTED =
2944 "android.intent.action.USER_STARTED";
2945
2946 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002947 * Broadcast sent when a user is in the process of starting. Carries an extra
2948 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2949 * sent to registered receivers, not manifest receivers. It is sent to all
2950 * users (including the one that is being started). You must hold
2951 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2952 * this broadcast. This is sent as a background broadcast, since
2953 * its result is not part of the primary UX flow; to safely keep track of
2954 * started/stopped state of a user you can use this in conjunction with
2955 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2956 * other user state broadcasts since those are foreground broadcasts so can
2957 * execute in a different order.
2958 * @hide
2959 */
2960 public static final String ACTION_USER_STARTING =
2961 "android.intent.action.USER_STARTING";
2962
2963 /**
2964 * Broadcast sent when a user is going to be stopped. Carries an extra
2965 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2966 * sent to registered receivers, not manifest receivers. It is sent to all
2967 * users (including the one that is being stopped). You must hold
2968 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2969 * this broadcast. The user will not stop until all receivers have
2970 * handled the broadcast. This is sent as a background broadcast, since
2971 * its result is not part of the primary UX flow; to safely keep track of
2972 * started/stopped state of a user you can use this in conjunction with
2973 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2974 * other user state broadcasts since those are foreground broadcasts so can
2975 * execute in a different order.
2976 * @hide
2977 */
2978 public static final String ACTION_USER_STOPPING =
2979 "android.intent.action.USER_STOPPING";
2980
2981 /**
2982 * Broadcast sent to the system when a user is stopped. Carries an extra
2983 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2984 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2985 * specific package. This is only sent to registered receivers, not manifest
2986 * receivers. It is sent to all running users <em>except</em> the one that
2987 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002988 * @hide
2989 */
2990 public static final String ACTION_USER_STOPPED =
2991 "android.intent.action.USER_STOPPED";
2992
2993 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002994 * 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 -07002995 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002996 * one that has been removed. The user will not be completely removed until all receivers have
2997 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002998 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002999 * @hide
3000 */
3001 public static final String ACTION_USER_REMOVED =
3002 "android.intent.action.USER_REMOVED";
3003
3004 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003005 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003006 * the userHandle of the user to become the current one. This is only sent to
3007 * registered receivers, not manifest receivers. It is sent to all running users.
3008 * You must hold
3009 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003010 * @hide
3011 */
3012 public static final String ACTION_USER_SWITCHED =
3013 "android.intent.action.USER_SWITCHED";
3014
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003015 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003016 * Broadcast Action: Sent when the credential-encrypted private storage has
3017 * become unlocked for the target user. This is only sent to registered
3018 * receivers, not manifest receivers.
3019 */
3020 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3021 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3022
3023 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003024 * Broadcast sent to the system when a user's information changes. Carries an extra
3025 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003026 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003027 * @hide
3028 */
3029 public static final String ACTION_USER_INFO_CHANGED =
3030 "android.intent.action.USER_INFO_CHANGED";
3031
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003032 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003033 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3034 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003035 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3036 * that need to display merged content across both primary and managed profiles need to
3037 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003038 * not manifest receivers.
3039 */
3040 public static final String ACTION_MANAGED_PROFILE_ADDED =
3041 "android.intent.action.MANAGED_PROFILE_ADDED";
3042
3043 /**
3044 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003045 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3046 * Only applications (for example Launchers) that need to display merged content across both
3047 * primary and managed profiles need to worry about this broadcast. This is only sent to
3048 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003049 */
3050 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3051 "android.intent.action.MANAGED_PROFILE_REMOVED";
3052
3053 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003054 * Broadcast sent to the primary user when the credential-encrypted private storage for
3055 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3056 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3057 * Launchers) that need to display merged content across both primary and managed profiles
3058 * need to worry about this broadcast. This is only sent to registered receivers,
3059 * not manifest receivers.
3060 */
3061 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3062 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3063
3064 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003065 * Broadcast sent to the primary user when an associated managed profile has become available.
3066 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003067 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3068 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3069 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003070 */
Rubin Xue95057a2016-04-01 16:49:25 +01003071 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3072 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3073
3074 /**
3075 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3076 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3077 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3078 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3079 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3080 */
3081 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3082 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003083
3084 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003085 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3086 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3087 * the device was locked or unlocked.
3088 *
3089 * This is only sent to registered receivers.
3090 *
3091 * @hide
3092 */
3093 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3094 "android.intent.action.DEVICE_LOCKED_CHANGED";
3095
3096 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003097 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3098 */
3099 public static final String ACTION_QUICK_CLOCK =
3100 "android.intent.action.QUICK_CLOCK";
3101
Michael Wright0087a142013-02-05 16:29:39 -08003102 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003103 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003104 * @hide
3105 */
3106 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3107 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3108
Justin Kohd378ad72013-04-01 12:18:26 -07003109 /**
3110 * Broadcast Action: A global button was pressed. Includes a single
3111 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3112 * caused the broadcast.
3113 * @hide
3114 */
3115 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3116
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003117 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003118 * Broadcast Action: Sent when media resource is granted.
3119 * <p>
3120 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3121 * granted.
3122 * </p>
3123 * <p class="note">
3124 * This is a protected intent that can only be sent by the system.
3125 * </p>
3126 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003127 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003128 * </p>
3129 *
3130 * @hide
3131 */
3132 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3133 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3134
3135 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003136 * Broadcast Action: An overlay package has been installed. The data
3137 * contains the name of the added overlay package.
3138 * @hide
3139 */
3140 public static final String ACTION_OVERLAY_ADDED = "android.intent.action.OVERLAY_ADDED";
3141
3142 /**
3143 * Broadcast Action: An overlay package has changed. The data contains the
3144 * name of the overlay package which has changed. This is broadcast on all
3145 * changes to the OverlayInfo returned by {@link
3146 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3147 * most common change is a state change that will change whether the
3148 * overlay is enabled or not.
3149 * @hide
3150 */
3151 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3152
3153 /**
3154 * Broadcast Action: An overlay package has been removed. The data contains
3155 * the name of the overlay package which has been removed.
3156 * @hide
3157 */
3158 public static final String ACTION_OVERLAY_REMOVED = "android.intent.action.OVERLAY_REMOVED";
3159
3160 /**
3161 * Broadcast Action: The order of a package's list of overlay packages has
3162 * changed. The data contains the package name of the overlay package that
3163 * had its position in the list adjusted.
3164 * @hide
3165 */
3166 public static final String
3167 ACTION_OVERLAY_PRIORITY_CHANGED = "android.intent.action.OVERLAY_PRIORITY_CHANGED";
3168
3169 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003170 * Activity Action: Allow the user to select and return one or more existing
3171 * documents. When invoked, the system will display the various
3172 * {@link DocumentsProvider} instances installed on the device, letting the
3173 * user interactively navigate through them. These documents include local
3174 * media, such as photos and video, and documents provided by installed
3175 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003176 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003177 * Each document is represented as a {@code content://} URI backed by a
3178 * {@link DocumentsProvider}, which can be opened as a stream with
3179 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3180 * {@link android.provider.DocumentsContract.Document} metadata.
3181 * <p>
3182 * All selected documents are returned to the calling application with
3183 * persistable read and write permission grants. If you want to maintain
3184 * access to the documents across device reboots, you need to explicitly
3185 * take the persistable permissions using
3186 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3187 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003188 * Callers must indicate the acceptable document MIME types through
3189 * {@link #setType(String)}. For example, to select photos, use
3190 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3191 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3192 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003193 * <p>
3194 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003195 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3196 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003197 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003198 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3199 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003200 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003201 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003202 * Callers can set a document URI through
3203 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3204 * location of documents navigator. System will do its best to launch the
3205 * navigator in the specified document if it's a folder, or the folder that
3206 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003207 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003208 * Output: The URI of the item that was picked, returned in
3209 * {@link #getData()}. This must be a {@code content://} URI so that any
3210 * receiver can access it. If multiple documents were selected, they are
3211 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003212 *
3213 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003214 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003215 * @see #ACTION_CREATE_DOCUMENT
3216 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003217 */
3218 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3219 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3220
3221 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003222 * Activity Action: Allow the user to create a new document. When invoked,
3223 * the system will display the various {@link DocumentsProvider} instances
3224 * installed on the device, letting the user navigate through them. The
3225 * returned document may be a newly created document with no content, or it
3226 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003227 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003228 * Each document is represented as a {@code content://} URI backed by a
3229 * {@link DocumentsProvider}, which can be opened as a stream with
3230 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3231 * {@link android.provider.DocumentsContract.Document} metadata.
3232 * <p>
3233 * Callers must indicate the concrete MIME type of the document being
3234 * created by setting {@link #setType(String)}. This MIME type cannot be
3235 * changed after the document is created.
3236 * <p>
3237 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3238 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003239 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003240 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3241 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003242 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003243 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003244 * Callers can set a document URI through
3245 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3246 * location of documents navigator. System will do its best to launch the
3247 * navigator in the specified document if it's a folder, or the folder that
3248 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003249 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003250 * Output: The URI of the item that was created. This must be a
3251 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003252 *
3253 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003254 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003255 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003256 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003257 */
3258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3259 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3260
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003261 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003262 * Activity Action: Allow the user to pick a directory subtree. When
3263 * invoked, the system will display the various {@link DocumentsProvider}
3264 * instances installed on the device, letting the user navigate through
3265 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003266 * <p>
3267 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003268 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3269 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3270 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003271 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003272 * Callers can set a document URI through
3273 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3274 * location of documents navigator. System will do its best to launch the
3275 * navigator in the specified document if it's a folder, or the folder that
3276 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003277 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003278 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003279 *
3280 * @see DocumentsContract
3281 */
3282 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003283 public static final String
3284 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003285
Felipe Lemec7b1f892016-01-15 15:02:31 -08003286 /**
Peng Xua35b5532016-01-20 00:05:45 -08003287 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3288 * exisiting sensor being disconnected.
3289 *
3290 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3291 *
3292 * {@hide}
3293 */
3294 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3295 public static final String
3296 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3297
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003298 /**
3299 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3300 *
3301 * {@hide}
3302 */
3303 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003304 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3305
Christopher Tate6597e342015-02-17 12:15:25 -08003306 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003307 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3308 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3309 *
3310 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3311 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003312 * @hide
3313 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003314 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003315 public static final String EXTRA_FORCE_MASTER_CLEAR =
3316 "android.intent.extra.FORCE_MASTER_CLEAR";
3317
3318 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003319 * A broadcast action to trigger a factory reset.
3320 *
3321 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3322 *
3323 * <p>Not for use by third-party applications.
3324 *
3325 * @see #EXTRA_FORCE_MASTER_CLEAR
3326 *
3327 * {@hide}
3328 */
3329 @SystemApi
3330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3331 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3332
3333 /**
3334 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3335 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3336 *
3337 * <p>Not for use by third-party applications.
3338 *
3339 * @hide
3340 */
3341 @SystemApi
3342 public static final String EXTRA_FORCE_FACTORY_RESET =
3343 "android.intent.extra.FORCE_FACTORY_RESET";
3344
3345 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003346 * Broadcast action: report that a settings element is being restored from backup. The intent
3347 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3348 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3349 * is the value of that settings entry prior to the restore operation. All of these values are
3350 * represented as strings.
3351 *
3352 * <p>This broadcast is sent only for settings provider entries known to require special handling
3353 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3354 * the provider's backup agent implementation.
3355 *
3356 * @see #EXTRA_SETTING_NAME
3357 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3358 * @see #EXTRA_SETTING_NEW_VALUE
3359 * {@hide}
3360 */
3361 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3362
3363 /** {@hide} */
3364 public static final String EXTRA_SETTING_NAME = "setting_name";
3365 /** {@hide} */
3366 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3367 /** {@hide} */
3368 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3369
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003370 /**
3371 * Activity Action: Process a piece of text.
3372 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3373 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3374 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3375 */
3376 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3377 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3378 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003379 * The name of the extra used to define the text to be processed, as a
3380 * CharSequence. Note that this may be a styled CharSequence, so you must use
3381 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003382 */
3383 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3384 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003385 * The name of the boolean extra used to define if the processed text will be used as read-only.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003386 */
3387 public static final String EXTRA_PROCESS_TEXT_READONLY =
3388 "android.intent.extra.PROCESS_TEXT_READONLY";
3389
Bryce Leebc58f592015-09-25 16:43:01 -07003390 /**
3391 * Broadcast action: reports when a new thermal event has been reached. When the device
3392 * is reaching its maximum temperatue, the thermal level reported
3393 * {@hide}
3394 */
3395 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3396 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3397
3398 /** {@hide} */
3399 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3400
3401 /**
3402 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003403 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003404 * {@hide}
3405 */
3406 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3407
3408 /**
3409 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003410 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003411 * {@hide}
3412 */
3413 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3414
3415 /**
3416 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003417 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003418 * {@hide}
3419 */
3420 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3421
3422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003423 // ---------------------------------------------------------------------
3424 // ---------------------------------------------------------------------
3425 // Standard intent categories (see addCategory()).
3426
3427 /**
3428 * Set if the activity should be an option for the default action
3429 * (center press) to perform on a piece of data. Setting this will
3430 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003431 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003432 * Intent when initiating an action -- it is for use in intent filters
3433 * specified in packages.
3434 */
3435 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3436 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3437 /**
3438 * Activities that can be safely invoked from a browser must support this
3439 * category. For example, if the user is viewing a web page or an e-mail
3440 * and clicks on a link in the text, the Intent generated execute that
3441 * link will require the BROWSABLE category, so that only activities
3442 * supporting this category will be considered as possible actions. By
3443 * supporting this category, you are promising that there is nothing
3444 * damaging (without user intervention) that can happen by invoking any
3445 * matching Intent.
3446 */
3447 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3448 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3449 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003450 * Categories for activities that can participate in voice interaction.
3451 * An activity that supports this category must be prepared to run with
3452 * no UI shown at all (though in some case it may have a UI shown), and
3453 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3454 */
3455 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3456 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3457 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003458 * Set if the activity should be considered as an alternative action to
3459 * the data the user is currently viewing. See also
3460 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3461 * applies to the selection in a list of items.
3462 *
3463 * <p>Supporting this category means that you would like your activity to be
3464 * displayed in the set of alternative things the user can do, usually as
3465 * part of the current activity's options menu. You will usually want to
3466 * include a specific label in the &lt;intent-filter&gt; of this action
3467 * describing to the user what it does.
3468 *
3469 * <p>The action of IntentFilter with this category is important in that it
3470 * describes the specific action the target will perform. This generally
3471 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3472 * a specific name such as "com.android.camera.action.CROP. Only one
3473 * alternative of any particular action will be shown to the user, so using
3474 * a specific action like this makes sure that your alternative will be
3475 * displayed while also allowing other applications to provide their own
3476 * overrides of that particular action.
3477 */
3478 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3479 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3480 /**
3481 * Set if the activity should be considered as an alternative selection
3482 * action to the data the user has currently selected. This is like
3483 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3484 * of items from which the user can select, giving them alternatives to the
3485 * default action that will be performed on it.
3486 */
3487 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3488 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3489 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003490 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003491 */
3492 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3493 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3494 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003495 * Should be displayed in the top-level launcher.
3496 */
3497 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3498 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3499 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003500 * Indicates an activity optimized for Leanback mode, and that should
3501 * be displayed in the Leanback launcher.
3502 */
3503 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3504 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3505 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003506 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3507 * @hide
3508 */
3509 @SystemApi
3510 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3511 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003512 * Provides information about the package it is in; typically used if
3513 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3514 * a front-door to the user without having to be shown in the all apps list.
3515 */
3516 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3517 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3518 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003519 * This is the home activity, that is the first activity that is displayed
3520 * when the device boots.
3521 */
3522 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3523 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3524 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003525 * This is the home activity that is displayed when the device is finished setting up and ready
3526 * for use.
3527 * @hide
3528 */
3529 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3530 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3531 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003532 * This is the setup wizard activity, that is the first activity that is displayed
3533 * when the user sets up the device for the first time.
3534 * @hide
3535 */
3536 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3537 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3538 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003539 * This activity is a preference panel.
3540 */
3541 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3542 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3543 /**
3544 * This activity is a development preference panel.
3545 */
3546 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3547 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3548 /**
3549 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003550 */
3551 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3552 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3553 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003554 * This activity allows the user to browse and download new applications.
3555 */
3556 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3557 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3558 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003559 * This activity may be exercised by the monkey or other automated test tools.
3560 */
3561 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3562 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3563 /**
3564 * To be used as a test (not part of the normal user experience).
3565 */
3566 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3567 /**
3568 * To be used as a unit test (run through the Test Harness).
3569 */
3570 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3571 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003572 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003573 * experience).
3574 */
3575 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003576
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003577 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003578 * Used to indicate that an intent only wants URIs that can be opened with
3579 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3580 * must support at least the columns defined in {@link OpenableColumns} when
3581 * queried.
3582 *
3583 * @see #ACTION_GET_CONTENT
3584 * @see #ACTION_OPEN_DOCUMENT
3585 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003586 */
3587 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3588 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3589
3590 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003591 * Used to indicate that an intent filter can accept files which are not necessarily
3592 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3593 * at least streamable via
3594 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3595 * using one of the stream types exposed via
3596 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3597 *
3598 * @see #ACTION_SEND
3599 * @see #ACTION_SEND_MULTIPLE
3600 */
3601 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3602 public static final String CATEGORY_TYPED_OPENABLE =
3603 "android.intent.category.TYPED_OPENABLE";
3604
3605 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003606 * To be used as code under test for framework instrumentation tests.
3607 */
3608 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3609 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003610 /**
3611 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003612 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3613 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003614 */
3615 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3616 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3617 /**
3618 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003619 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3620 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003621 */
3622 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3623 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003624 /**
3625 * An activity to run when device is inserted into a analog (low end) dock.
3626 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3627 * information, see {@link android.app.UiModeManager}.
3628 */
3629 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3630 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3631
3632 /**
3633 * An activity to run when device is inserted into a digital (high end) dock.
3634 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3635 * information, see {@link android.app.UiModeManager}.
3636 */
3637 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3638 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003639
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003640 /**
3641 * Used to indicate that the activity can be used in a car environment.
3642 */
3643 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3644 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3645
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003646 // ---------------------------------------------------------------------
3647 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003648 // Application launch intent categories (see addCategory()).
3649
3650 /**
3651 * Used with {@link #ACTION_MAIN} to launch the browser application.
3652 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003653 * <p>NOTE: This should not be used as the primary key of an Intent,
3654 * since it will not result in the app launching with the correct
3655 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003656 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003657 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003658 */
3659 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3660 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3661
3662 /**
3663 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3664 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003665 * <p>NOTE: This should not be used as the primary key of an Intent,
3666 * since it will not result in the app launching with the correct
3667 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003668 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003669 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003670 */
3671 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3672 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3673
3674 /**
3675 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3676 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003677 * <p>NOTE: This should not be used as the primary key of an Intent,
3678 * since it will not result in the app launching with the correct
3679 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003680 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003681 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003682 */
3683 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3684 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3685
3686 /**
3687 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3688 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003689 * <p>NOTE: This should not be used as the primary key of an Intent,
3690 * since it will not result in the app launching with the correct
3691 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003692 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003693 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003694 */
3695 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3696 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3697
3698 /**
3699 * Used with {@link #ACTION_MAIN} to launch the email application.
3700 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003701 * <p>NOTE: This should not be used as the primary key of an Intent,
3702 * since it will not result in the app launching with the correct
3703 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003704 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003705 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003706 */
3707 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3708 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3709
3710 /**
3711 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3712 * The activity should be able to view and manipulate image and video files
3713 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003714 * <p>NOTE: This should not be used as the primary key of an Intent,
3715 * since it will not result in the app launching with the correct
3716 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003717 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003718 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003719 */
3720 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3721 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3722
3723 /**
3724 * Used with {@link #ACTION_MAIN} to launch the maps application.
3725 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003726 * <p>NOTE: This should not be used as the primary key of an Intent,
3727 * since it will not result in the app launching with the correct
3728 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003729 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003730 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003731 */
3732 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3733 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3734
3735 /**
3736 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3737 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003738 * <p>NOTE: This should not be used as the primary key of an Intent,
3739 * since it will not result in the app launching with the correct
3740 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003741 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003742 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003743 */
3744 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3745 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3746
3747 /**
3748 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003749 * The activity should be able to play, browse, or manipulate music files
3750 * stored on the device.
3751 * <p>NOTE: This should not be used as the primary key of an Intent,
3752 * since it will not result in the app launching with the correct
3753 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003754 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003755 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003756 */
3757 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3758 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3759
3760 // ---------------------------------------------------------------------
3761 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003762 // Standard extra data keys.
3763
3764 /**
3765 * The initial data to place in a newly created record. Use with
3766 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3767 * fields as would be given to the underlying ContentProvider.insert()
3768 * call.
3769 */
3770 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3771
3772 /**
3773 * A constant CharSequence that is associated with the Intent, used with
3774 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3775 * this may be a styled CharSequence, so you must use
3776 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3777 * retrieve it.
3778 */
3779 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3780
3781 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003782 * A constant String that is associated with the Intent, used with
3783 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3784 * as HTML formatted text. Note that you <em>must</em> also supply
3785 * {@link #EXTRA_TEXT}.
3786 */
3787 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3788
3789 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003790 * A content: URI holding a stream of data associated with the Intent,
3791 * used with {@link #ACTION_SEND} to supply the data being sent.
3792 */
3793 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3794
3795 /**
3796 * A String[] holding e-mail addresses that should be delivered to.
3797 */
3798 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3799
3800 /**
3801 * A String[] holding e-mail addresses that should be carbon copied.
3802 */
3803 public static final String EXTRA_CC = "android.intent.extra.CC";
3804
3805 /**
3806 * A String[] holding e-mail addresses that should be blind carbon copied.
3807 */
3808 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3809
3810 /**
3811 * A constant string holding the desired subject line of a message.
3812 */
3813 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3814
3815 /**
3816 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003817 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003818 */
3819 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3820
3821 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003822 * An int representing the user id to be used.
3823 *
3824 * @hide
3825 */
3826 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3827
3828 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003829 * An int representing the task id to be retrieved. This is used when a launch from recents is
3830 * intercepted by another action such as credentials confirmation to remember which task should
3831 * be resumed when complete.
3832 *
3833 * @hide
3834 */
3835 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3836
3837 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003838 * An Intent[] describing additional, alternate choices you would like shown with
3839 * {@link #ACTION_CHOOSER}.
3840 *
3841 * <p>An app may be capable of providing several different payload types to complete a
3842 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3843 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3844 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3845 * photo data or a hosted link where the photos can be viewed.</p>
3846 *
3847 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3848 * first/primary/preferred intent in the set. Additional intents specified in
3849 * this extra are ordered; by default intents that appear earlier in the array will be
3850 * preferred over intents that appear later in the array as matches for the same
3851 * target component. To alter this preference, a calling app may also supply
3852 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3853 */
3854 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3855
3856 /**
Adam Powell52c39212016-04-07 15:14:18 -07003857 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3858 * and omitted from a list of components presented to the user.
3859 *
3860 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3861 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3862 * from your own package or other apps from your organization if the idea of sending to those
3863 * targets would be redundant with other app functionality. Filtered components will not
3864 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3865 */
3866 public static final String EXTRA_EXCLUDE_COMPONENTS
3867 = "android.intent.extra.EXCLUDE_COMPONENTS";
3868
3869 /**
3870 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3871 * describing additional high-priority deep-link targets for the chooser to present to the user.
3872 *
3873 * <p>Targets provided in this way will be presented inline with all other targets provided
3874 * by services from other apps. They will be prioritized before other service targets, but
3875 * after those targets provided by sources that the user has manually pinned to the front.</p>
3876 *
3877 * @see #ACTION_CHOOSER
3878 */
3879 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3880
3881 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003882 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3883 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3884 *
3885 * <p>An app preparing an action for another app to complete may wish to allow the user to
3886 * disambiguate between several options for completing the action based on the chosen target
3887 * or otherwise refine the action before it is invoked.
3888 * </p>
3889 *
3890 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3891 * <ul>
3892 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3893 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3894 * chosen target beyond the first</li>
3895 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3896 * should fill in and send once the disambiguation is complete</li>
3897 * </ul>
3898 */
3899 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3900 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3901
3902 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08003903 * An {@code ArrayList} of {@code String} annotations describing content for
3904 * {@link #ACTION_CHOOSER}.
3905 *
3906 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
3907 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
3908 *
3909 * <p>Annotations should describe the major components or topics of the content. It is up to
3910 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
3911 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
3912 * start {@link #ACTION_CHOOSER}. Performance on customized annotations can suffer, if they are
3913 * rarely used for {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to
3914 * use the following annotations when applicable:</p>
3915 * <ul>
3916 * <li>"product": represents that the topic of the content is mainly about products, e.g.,
3917 * health & beauty, and office supplies.</li>
3918 * <li>"emotion": represents that the topic of the content is mainly about emotions, e.g.,
3919 * happy, and sad.</li>
3920 * <li>"person": represents that the topic of the content is mainly about persons, e.g.,
3921 * face, finger, standing, and walking.</li>
3922 * <li>"child": represents that the topic of the content is mainly about children, e.g.,
3923 * child, and baby.</li>
3924 * <li>"selfie": represents that the topic of the content is mainly about selfies.</li>
3925 * <li>"crowd": represents that the topic of the content is mainly about crowds.</li>
3926 * <li>"party": represents that the topic of the content is mainly about parties.</li>
3927 * <li>"animal": represent that the topic of the content is mainly about animals.</li>
3928 * <li>"plant": represents that the topic of the content is mainly about plants, e.g.,
3929 * flowers.</li>
3930 * <li>"vacation": represents that the topic of the content is mainly about vacations.</li>
3931 * <li>"fashion": represents that the topic of the content is mainly about fashion, e.g.
3932 * sunglasses, jewelry, handbags and clothing.</li>
3933 * <li>"material": represents that the topic of the content is mainly about materials, e.g.,
3934 * paper, and silk.</li>
3935 * <li>"vehicle": represents that the topic of the content is mainly about vehicles, like
3936 * cars, and boats.</li>
3937 * <li>"document": represents that the topic of the content is mainly about documents, e.g.
3938 * posters.</li>
3939 * <li>"design": represents that the topic of the content is mainly about design, e.g. arts
3940 * and designs of houses.</li>
3941 * <li>"holiday": represents that the topic of the content is mainly about holidays, e.g.,
3942 * Christmas and Thanksgiving.</li>
3943 * </ul>
3944 */
3945 public static final String EXTRA_CONTENT_ANNOTATIONS
3946 = "android.intent.extra.CONTENT_ANNOTATIONS";
3947
3948 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003949 * A {@link ResultReceiver} used to return data back to the sender.
3950 *
3951 * <p>Used to complete an app-specific
3952 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3953 *
3954 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3955 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3956 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3957 * when the user selects a target component from the chooser. It is up to the recipient
3958 * to send a result to this ResultReceiver to signal that disambiguation is complete
3959 * and that the chooser should invoke the user's choice.</p>
3960 *
3961 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3962 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3963 * to match and fill in the final Intent or ChooserTarget before starting it.
3964 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3965 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3966 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3967 *
3968 * <p>The result code passed to the ResultReceiver should be
3969 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3970 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3971 * the chooser should finish without starting a target.</p>
3972 */
3973 public static final String EXTRA_RESULT_RECEIVER
3974 = "android.intent.extra.RESULT_RECEIVER";
3975
3976 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003977 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003978 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003979 */
3980 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3981
3982 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003983 * A Parcelable[] of {@link Intent} or
3984 * {@link android.content.pm.LabeledIntent} objects as set with
3985 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3986 * a the front of the list of choices, when shown to the user with a
3987 * {@link #ACTION_CHOOSER}.
3988 */
3989 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3990
3991 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003992 * A {@link IntentSender} to start after ephemeral installation success.
3993 * @hide
3994 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003995 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3996
3997 /**
3998 * A {@link IntentSender} to start after ephemeral installation failure.
3999 * @hide
4000 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004001 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4002
4003 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004004 * The host name that triggered an ephemeral resolution.
4005 * @hide
4006 */
4007 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4008
4009 /**
4010 * An opaque token to track ephemeral resolution.
4011 * @hide
4012 */
4013 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4014
4015 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004016 * The version code of the app to install components from.
4017 * @hide
4018 */
4019 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4020
4021 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004022 * A Bundle forming a mapping of potential target package names to different extras Bundles
4023 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4024 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4025 * be currently installed on the device.
4026 *
4027 * <p>An application may choose to provide alternate extras for the case where a user
4028 * selects an activity from a predetermined set of target packages. If the activity
4029 * the user selects from the chooser belongs to a package with its package name as
4030 * a key in this bundle, the corresponding extras for that package will be merged with
4031 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4032 * extra has the same key as an extra already present in the intent it will overwrite
4033 * the extra from the intent.</p>
4034 *
4035 * <p><em>Examples:</em>
4036 * <ul>
4037 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4038 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4039 * parameters for that target.</li>
4040 * <li>An application may offer additional metadata for known targets of a given intent
4041 * to pass along information only relevant to that target such as account or content
4042 * identifiers already known to that application.</li>
4043 * </ul></p>
4044 */
4045 public static final String EXTRA_REPLACEMENT_EXTRAS =
4046 "android.intent.extra.REPLACEMENT_EXTRAS";
4047
4048 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004049 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4050 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4051 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4052 * {@link ComponentName} of the chosen component.
4053 *
4054 * <p>In some situations this callback may never come, for example if the user abandons
4055 * the chooser, switches to another task or any number of other reasons. Apps should not
4056 * be written assuming that this callback will always occur.</p>
4057 */
4058 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4059 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4060
4061 /**
4062 * The {@link ComponentName} chosen by the user to complete an action.
4063 *
4064 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4065 */
4066 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4067
4068 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004069 * A {@link android.view.KeyEvent} object containing the event that
4070 * triggered the creation of the Intent it is in.
4071 */
4072 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4073
4074 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004075 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4076 * before shutting down.
4077 *
4078 * {@hide}
4079 */
4080 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4081
4082 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004083 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4084 * requested by the user.
4085 *
4086 * {@hide}
4087 */
4088 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4089 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4090
4091 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004092 * 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 -07004093 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4094 * of restarting the application.
4095 */
4096 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4097
4098 /**
4099 * A String holding the phone number originally entered in
4100 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4101 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4102 */
4103 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004104
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004105 /**
4106 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4107 * intents to supply the uid the package had been assigned. Also an optional
4108 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4109 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4110 * purpose.
4111 */
4112 public static final String EXTRA_UID = "android.intent.extra.UID";
4113
4114 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004115 * @hide String array of package names.
4116 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004117 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004118 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4119
4120 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004121 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4122 * intents to indicate whether this represents a full uninstall (removing
4123 * both the code and its data) or a partial uninstall (leaving its data,
4124 * implying that this is an update).
4125 */
4126 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004127
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004128 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004129 * @hide
4130 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4131 * intents to indicate that at this point the package has been removed for
4132 * all users on the device.
4133 */
4134 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4135 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4136
4137 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004138 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4139 * intents to indicate that this is a replacement of the package, so this
4140 * broadcast will immediately be followed by an add broadcast for a
4141 * different version of the same package.
4142 */
4143 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004144
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004145 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004146 * Used as an int extra field in {@link android.app.AlarmManager} intents
4147 * to tell the application being invoked how many pending alarms are being
4148 * delievered with the intent. For one-shot alarms this will always be 1.
4149 * For recurring alarms, this might be greater than 1 if the device was
4150 * asleep or powered off at the time an earlier alarm would have been
4151 * delivered.
4152 */
4153 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004154
Jacek Surazski86b6c532009-05-13 14:38:28 +02004155 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004156 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4157 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004158 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4159 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004160 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4161 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4162 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004163 */
4164 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4165
4166 /**
4167 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4168 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004169 */
4170 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4171
4172 /**
4173 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4174 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004175 */
4176 public static final int EXTRA_DOCK_STATE_DESK = 1;
4177
4178 /**
4179 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4180 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004181 */
4182 public static final int EXTRA_DOCK_STATE_CAR = 2;
4183
4184 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004185 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4186 * to represent that the phone is in a analog (low end) dock.
4187 */
4188 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4189
4190 /**
4191 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4192 * to represent that the phone is in a digital (high end) dock.
4193 */
4194 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4195
4196 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004197 * Boolean that can be supplied as meta-data with a dock activity, to
4198 * indicate that the dock should take over the home key when it is active.
4199 */
4200 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004201
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004202 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004203 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4204 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004205 */
4206 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4207
4208 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004209 * Used in the extra field in the remote intent. It's astring token passed with the
4210 * remote intent.
4211 */
4212 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4213 "android.intent.extra.remote_intent_token";
4214
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004215 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004216 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004217 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004218 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004219 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004220 "android.intent.extra.changed_component_name";
4221
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004222 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004223 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004224 * and contains a string array of all of the components that have changed. If
4225 * the state of the overall package has changed, then it will contain an entry
4226 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004227 */
4228 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4229 "android.intent.extra.changed_component_name_list";
4230
4231 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004232 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004233 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004234 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4235 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4236 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004237 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004238 */
4239 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4240 "android.intent.extra.changed_package_list";
4241
4242 /**
4243 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004244 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4245 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004246 * and contains an integer array of uids of all of the components
4247 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004248 */
4249 public static final String EXTRA_CHANGED_UID_LIST =
4250 "android.intent.extra.changed_uid_list";
4251
4252 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004253 * @hide
4254 * Magic extra system code can use when binding, to give a label for
4255 * who it is that has bound to a service. This is an integer giving
4256 * a framework string resource that can be displayed to the user.
4257 */
4258 public static final String EXTRA_CLIENT_LABEL =
4259 "android.intent.extra.client_label";
4260
4261 /**
4262 * @hide
4263 * Magic extra system code can use when binding, to give a PendingIntent object
4264 * that can be launched for the user to disable the system's use of this
4265 * service.
4266 */
4267 public static final String EXTRA_CLIENT_INTENT =
4268 "android.intent.extra.client_intent";
4269
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004270 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004271 * Extra used to indicate that an intent should only return data that is on
4272 * the local device. This is a boolean extra; the default is false. If true,
4273 * an implementation should only allow the user to select data that is
4274 * already on the device, not requiring it be downloaded from a remote
4275 * service when opened.
4276 *
4277 * @see #ACTION_GET_CONTENT
4278 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004279 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004280 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004281 */
4282 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004283 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004284
Amith Yamasani13593602012-03-22 16:16:17 -07004285 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004286 * Extra used to indicate that an intent can allow the user to select and
4287 * return multiple items. This is a boolean extra; the default is false. If
4288 * true, an implementation is allowed to present the user with a UI where
4289 * they can pick multiple items that are all returned to the caller. When
4290 * this happens, they should be returned as the {@link #getClipData()} part
4291 * of the result Intent.
4292 *
4293 * @see #ACTION_GET_CONTENT
4294 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004295 */
4296 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004297 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004298
4299 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004300 * The integer userHandle carried with broadcast intents related to addition, removal and
4301 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4302 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4303 *
Amith Yamasani13593602012-03-22 16:16:17 -07004304 * @hide
4305 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004306 public static final String EXTRA_USER_HANDLE =
4307 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004308
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004309 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004310 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4311 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4312 */
4313 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004314 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004315
4316 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004317 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004318 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4319 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004320 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004321 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4322
4323 /**
4324 * Extra sent in the intent to the BroadcastReceiver that handles
4325 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4326 * the restrictions as key/value pairs.
4327 */
4328 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4329 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004330
Amith Yamasani86118ba2013-03-28 14:33:16 -07004331 /**
4332 * Extra used in the response from a BroadcastReceiver that handles
4333 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4334 */
4335 public static final String EXTRA_RESTRICTIONS_INTENT =
4336 "android.intent.extra.restrictions_intent";
4337
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004338 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004339 * Extra used to communicate a set of acceptable MIME types. The type of the
4340 * extra is {@code String[]}. Values may be a combination of concrete MIME
4341 * types (such as "image/png") and/or partial MIME types (such as
4342 * "audio/*").
4343 *
4344 * @see #ACTION_GET_CONTENT
4345 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004346 */
4347 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4348
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004349 /**
4350 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4351 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004352 * When this is true, hardware devices can use this information to determine that
4353 * they shouldn't do a complete shutdown of their device since this is not a
4354 * complete shutdown down to the kernel, but only user space restarting.
4355 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004356 */
4357 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4358 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4359
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004360 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004361 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4362 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4363 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4364 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004365 *
4366 * @hide for internal use only.
4367 */
4368 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4369 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004370 /** @hide */
4371 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4372 /** @hide */
4373 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4374 /** @hide */
4375 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004376
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004377 /** {@hide} */
4378 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4379
Rubin Xue8490f12015-06-25 12:17:48 +01004380 /** {@hide} */
4381 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4382
Santos Cordon15a13782015-03-31 18:32:31 -07004383 /**
4384 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4385 * activation request.
4386 * TODO: Add information about the structure and response data used with the pending intent.
4387 * @hide
4388 */
4389 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4390 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4391
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004392 /**
4393 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004394 *
4395 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004396 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004397 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4398
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004399 /**
4400 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004401 * When a profile goes into quiet mode, all apps in the profile are killed and the
4402 * profile user is stopped. Widgets originating from the profile are masked, and app
4403 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004404 */
4405 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004406
4407 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004408 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004409 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004410 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4411 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004412 *
4413 * @hide
4414 */
4415 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4416 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4417
4418 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004419 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4420 * whether to show the chooser or not when there is only one application available
4421 * to choose from.
4422 *
4423 * @hide
4424 */
4425 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4426 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4427
4428 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004429 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004430 * to represent that a video codec is allowed to use.
4431 *
4432 * @hide
4433 */
4434 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4435
4436 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004437 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004438 * to represent that a audio codec is allowed to use.
4439 *
4440 * @hide
4441 */
4442 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4443
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004444 // ---------------------------------------------------------------------
4445 // ---------------------------------------------------------------------
4446 // Intent flags (see mFlags variable).
4447
Tor Norbyed9273d62013-05-30 15:59:53 -07004448 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004449 @IntDef(flag = true, value = {
4450 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4451 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004452 @Retention(RetentionPolicy.SOURCE)
4453 public @interface GrantUriMode {}
4454
Jeff Sharkey846318a2014-04-04 12:12:41 -07004455 /** @hide */
4456 @IntDef(flag = true, value = {
4457 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4458 @Retention(RetentionPolicy.SOURCE)
4459 public @interface AccessUriMode {}
4460
4461 /**
4462 * Test if given mode flags specify an access mode, which must be at least
4463 * read and/or write.
4464 *
4465 * @hide
4466 */
4467 public static boolean isAccessUriMode(int modeFlags) {
4468 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4469 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4470 }
4471
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004472 /**
4473 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004474 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004475 * specified in its ClipData. When applying to an Intent's ClipData,
4476 * all URIs as well as recursive traversals through data or other ClipData
4477 * in Intent items will be granted; only the grant flags of the top-level
4478 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004479 */
4480 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4481 /**
4482 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004483 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004484 * specified in its ClipData. When applying to an Intent's ClipData,
4485 * all URIs as well as recursive traversals through data or other ClipData
4486 * in Intent items will be granted; only the grant flags of the top-level
4487 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004488 */
4489 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4490 /**
4491 * Can be set by the caller to indicate that this Intent is coming from
4492 * a background operation, not from direct user interaction.
4493 */
4494 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4495 /**
4496 * A flag you can enable for debugging: when set, log messages will be
4497 * printed during the resolution of this intent to show you what has
4498 * been found to create the final resolved list.
4499 */
4500 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004501 /**
4502 * If set, this intent will not match any components in packages that
4503 * are currently stopped. If this is not set, then the default behavior
4504 * is to include such applications in the result.
4505 */
4506 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4507 /**
4508 * If set, this intent will always match any components in packages that
4509 * are currently stopped. This is the default behavior when
4510 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4511 * flags are set, this one wins (it allows overriding of exclude for
4512 * places where the framework may automatically set the exclude flag).
4513 */
4514 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004515
4516 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004517 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004518 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004519 * persisted across device reboots until explicitly revoked with
4520 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4521 * grant for possible persisting; the receiving application must call
4522 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4523 * actually persist.
4524 *
4525 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4526 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4527 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004528 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004529 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004530 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004531
4532 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004533 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4534 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4535 * applies to any URI that is a prefix match against the original granted
4536 * URI. (Without this flag, the URI must match exactly for access to be
4537 * granted.) Another URI is considered a prefix match only when scheme,
4538 * authority, and all path segments defined by the prefix are an exact
4539 * match.
4540 */
4541 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4542
4543 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004544 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004545 * homework and verified that they correctly handle packages and components
4546 * that come and go over time. In particular:
4547 * <ul>
4548 * <li>Apps installed on external storage, which will appear to be
4549 * uninstalled while the the device is ejected.
4550 * <li>Apps with encryption unaware components, which will appear to not
4551 * exist while the device is locked.
4552 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004553 *
4554 * @hide
4555 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004556 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004557
4558 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004559 * Internal flag used to indicate ephemeral applications should not be
4560 * considered when resolving the intent.
4561 *
4562 * @hide
4563 */
4564 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4565
4566 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004567 * If set, the new activity is not kept in the history stack. As soon as
4568 * the user navigates away from it, the activity is finished. This may also
4569 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4570 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004571 *
4572 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4573 * is never invoked when the current activity starts a new activity which
4574 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004575 */
4576 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4577 /**
4578 * If set, the activity will not be launched if it is already running
4579 * at the top of the history stack.
4580 */
4581 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4582 /**
4583 * If set, this activity will become the start of a new task on this
4584 * history stack. A task (from the activity that started it to the
4585 * next task activity) defines an atomic group of activities that the
4586 * user can move to. Tasks can be moved to the foreground and background;
4587 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004588 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004589 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4590 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004591 *
4592 * <p>This flag is generally used by activities that want
4593 * to present a "launcher" style behavior: they give the user a list of
4594 * separate things that can be done, which otherwise run completely
4595 * independently of the activity launching them.
4596 *
4597 * <p>When using this flag, if a task is already running for the activity
4598 * you are now starting, then a new activity will not be started; instead,
4599 * the current task will simply be brought to the front of the screen with
4600 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4601 * to disable this behavior.
4602 *
4603 * <p>This flag can not be used when the caller is requesting a result from
4604 * the activity being launched.
4605 */
4606 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4607 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004608 * This flag is used to create a new task and launch an activity into it.
4609 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4610 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4611 * search through existing tasks for ones matching this Intent. Only if no such
4612 * task is found would a new task be created. When paired with
4613 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4614 * the search for a matching task and unconditionally start a new task.
4615 *
4616 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4617 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004618 * top-level application launcher.</strong> Used in conjunction with
4619 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4620 * behavior of bringing an existing task to the foreground. When set,
4621 * a new task is <em>always</em> started to host the Activity for the
4622 * Intent, regardless of whether there is already an existing task running
4623 * the same thing.
4624 *
4625 * <p><strong>Because the default system does not include graphical task management,
4626 * you should not use this flag unless you provide some way for a user to
4627 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004628 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004629 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4630 * creating new document tasks.
4631 *
4632 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004633 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004634 *
Scott Main7aee61f2011-02-08 11:25:01 -08004635 * <p>See
4636 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4637 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004638 *
4639 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4640 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004641 */
4642 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4643 /**
4644 * If set, and the activity being launched is already running in the
4645 * current task, then instead of launching a new instance of that activity,
4646 * all of the other activities on top of it will be closed and this Intent
4647 * will be delivered to the (now on top) old activity as a new Intent.
4648 *
4649 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4650 * If D calls startActivity() with an Intent that resolves to the component
4651 * of activity B, then C and D will be finished and B receive the given
4652 * Intent, resulting in the stack now being: A, B.
4653 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004654 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004655 * either receive the new intent you are starting here in its
4656 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004657 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004658 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4659 * the same intent, then it will be finished and re-created; for all other
4660 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4661 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004662 *
4663 * <p>This launch mode can also be used to good effect in conjunction with
4664 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4665 * of a task, it will bring any currently running instance of that task
4666 * to the foreground, and then clear it to its root state. This is
4667 * especially useful, for example, when launching an activity from the
4668 * notification manager.
4669 *
Scott Main7aee61f2011-02-08 11:25:01 -08004670 * <p>See
4671 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4672 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004673 */
4674 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4675 /**
4676 * If set and this intent is being used to launch a new activity from an
4677 * existing one, then the reply target of the existing activity will be
4678 * transfered to the new activity. This way the new activity can call
4679 * {@link android.app.Activity#setResult} and have that result sent back to
4680 * the reply target of the original activity.
4681 */
4682 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4683 /**
4684 * If set and this intent is being used to launch a new activity from an
4685 * existing one, the current activity will not be counted as the top
4686 * activity for deciding whether the new intent should be delivered to
4687 * the top instead of starting a new one. The previous activity will
4688 * be used as the top, with the assumption being that the current activity
4689 * will finish itself immediately.
4690 */
4691 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4692 /**
4693 * If set, the new activity is not kept in the list of recently launched
4694 * activities.
4695 */
4696 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4697 /**
4698 * This flag is not normally set by application code, but set for you by
4699 * the system as described in the
4700 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4701 * launchMode} documentation for the singleTask mode.
4702 */
4703 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4704 /**
4705 * If set, and this activity is either being started in a new task or
4706 * bringing to the top an existing task, then it will be launched as
4707 * the front door of the task. This will result in the application of
4708 * any affinities needed to have that task in the proper state (either
4709 * moving activities to or from it), or simply resetting that task to
4710 * its initial state if needed.
4711 */
4712 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4713 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004714 * This flag is not normally set by application code, but set for you by
4715 * the system if this activity is being launched from history
4716 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004717 */
4718 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004719 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004720 * @deprecated As of API 21 this performs identically to
4721 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004722 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004723 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004724 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004725 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004726 * This flag is used to open a document into a new task rooted at the activity launched
4727 * by this Intent. Through the use of this flag, or its equivalent attribute,
4728 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004729 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004730 *
Craig Mautner026596b2014-05-21 15:35:44 -07004731 * <p>The use of the activity attribute form of this,
4732 * {@link android.R.attr#documentLaunchMode}, is
4733 * preferred over the Intent flag described here. The attribute form allows the
4734 * Activity to specify multiple document behavior for all launchers of the Activity
4735 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004736 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004737 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4738 * it is kept after the activity is finished is different than the use of
4739 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4740 * this flag is being used to create a new recents entry, then by default that entry
4741 * will be removed once the activity is finished. You can modify this behavior with
4742 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4743 *
Craig Mautner026596b2014-05-21 15:35:44 -07004744 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4745 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4746 * equivalent of the Activity manifest specifying {@link
4747 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4748 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4749 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004750 *
Craig Mautner026596b2014-05-21 15:35:44 -07004751 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004752 *
Craig Mautner026596b2014-05-21 15:35:44 -07004753 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004754 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4755 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004756 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004757 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004758 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004759 * callback from occurring on the current frontmost activity before it is
4760 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004761 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004762 * <p>Typically, an activity can rely on that callback to indicate that an
4763 * explicit user action has caused their activity to be moved out of the
4764 * foreground. The callback marks an appropriate point in the activity's
4765 * lifecycle for it to dismiss any notifications that it intends to display
4766 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004767 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004768 * <p>If an activity is ever started via any non-user-driven events such as
4769 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4770 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004771 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004772 */
4773 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004774 /**
4775 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4776 * this flag will cause the launched activity to be brought to the front of its
4777 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004778 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004779 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4780 * If D calls startActivity() with an Intent that resolves to the component
4781 * of activity B, then B will be brought to the front of the history stack,
4782 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004783 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004784 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004785 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004786 */
4787 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004788 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004789 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4790 * this flag will prevent the system from applying an activity transition
4791 * animation to go to the next activity state. This doesn't mean an
4792 * animation will never run -- if another activity change happens that doesn't
4793 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004794 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004795 * when you are going to do a series of activity operations but the
4796 * animation seen by the user shouldn't be driven by the first activity
4797 * change but rather a later one.
4798 */
4799 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4800 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004801 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4802 * this flag will cause any existing task that would be associated with the
4803 * activity to be cleared before the activity is started. That is, the activity
4804 * becomes the new root of an otherwise empty task, and any old activities
4805 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4806 */
4807 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4808 /**
4809 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4810 * this flag will cause a newly launching task to be placed on top of the current
4811 * home activity task (if there is one). That is, pressing back from the task
4812 * will always return the user to home even if that was not the last activity they
4813 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4814 */
4815 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4816 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004817 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4818 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004819 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004820 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004821 * this flag. When set and the task's activity is finished, the recents
4822 * entry will remain in the interface for the user to re-launch it, like a
4823 * recents entry for a top-level application.
4824 * <p>
4825 * The receiving activity can override this request with
4826 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4827 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004828 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004829 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004830 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004831
4832 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004833 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4834 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004835 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4836 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004837 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004838 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004839
4840 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004841 * If set, when sending a broadcast only registered receivers will be
4842 * called -- no BroadcastReceiver components will be launched.
4843 */
4844 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004845 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004846 * If set, when sending a broadcast the new broadcast will replace
4847 * any existing pending broadcast that matches it. Matching is defined
4848 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4849 * true for the intents of the two broadcasts. When a match is found,
4850 * the new broadcast (and receivers associated with it) will replace the
4851 * existing one in the pending broadcast list, remaining at the same
4852 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004853 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004854 * <p>This flag is most typically used with sticky broadcasts, which
4855 * only care about delivering the most recent values of the broadcast
4856 * to their receivers.
4857 */
4858 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4859 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004860 * If set, when sending a broadcast the recipient is allowed to run at
4861 * foreground priority, with a shorter timeout interval. During normal
4862 * broadcasts the receivers are not automatically hoisted out of the
4863 * background priority class.
4864 */
4865 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4866 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004867 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4868 * They can still propagate results through to later receivers, but they can not prevent
4869 * later receivers from seeing the broadcast.
4870 */
4871 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4872 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004873 * If set, when sending a broadcast <i>before boot has completed</i> only
4874 * registered receivers will be called -- no BroadcastReceiver components
4875 * will be launched. Sticky intent state will be recorded properly even
4876 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4877 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004878 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004879 * <p>This flag is only for use by system sevices as a convenience to
4880 * avoid having to implement a more complex mechanism around detection
4881 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004882 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004883 * @hide
4884 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004885 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004886 /**
4887 * Set when this broadcast is for a boot upgrade, a special mode that
4888 * allows the broadcast to be sent before the system is ready and launches
4889 * the app process with no providers running in it.
4890 * @hide
4891 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004892 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004893 /**
4894 * If set, the broadcast will always go to manifest receivers in background (cached
4895 * or not running) apps, regardless of whether that would be done by default. By
4896 * default they will only receive broadcasts if the broadcast has specified an
4897 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08004898 *
4899 * NOTE: dumpstate uses this flag numerically, so when its value is changed
4900 * the broadcast code there must also be changed to match.
4901 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004902 * @hide
4903 */
4904 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4905 /**
4906 * If set, the broadcast will never go to manifest receivers in background (cached
4907 * or not running) apps, regardless of whether that would be done by default. By
4908 * default they will receive broadcasts if the broadcast has specified an
4909 * explicit component or package name.
4910 * @hide
4911 */
4912 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07004913 /**
4914 * If set, this broadcast is being sent from the shell.
4915 * @hide
4916 */
4917 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004918
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004919 /**
4920 * @hide Flags that can't be changed with PendingIntent.
4921 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004922 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4923 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4924 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004925
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004926 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004927 // ---------------------------------------------------------------------
4928 // toUri() and parseUri() options.
4929
4930 /**
4931 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4932 * always has the "intent:" scheme. This syntax can be used when you want
4933 * to later disambiguate between URIs that are intended to describe an
4934 * Intent vs. all others that should be treated as raw URIs. When used
4935 * with {@link #parseUri}, any other scheme will result in a generic
4936 * VIEW action for that raw URI.
4937 */
4938 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004939
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004940 /**
4941 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4942 * always has the "android-app:" scheme. This is a variation of
4943 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4944 * http/https URI being delivered to a specific package name. The format
4945 * is:
4946 *
4947 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004948 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004949 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004950 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4951 * you must also include a scheme; including a path also requires both a host and a scheme.
4952 * The final #Intent; fragment can be used without a scheme, host, or path.
4953 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004954 * used with intents that have a {@link #setSelector}, since the base intent
4955 * will always have an explicit package name.</p>
4956 *
4957 * <p>Some examples of how this scheme maps to Intent objects:</p>
4958 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4959 * <colgroup align="left" />
4960 * <colgroup align="left" />
4961 * <thead>
4962 * <tr><th>URI</th> <th>Intent</th></tr>
4963 * </thead>
4964 *
4965 * <tbody>
4966 * <tr><td><code>android-app://com.example.app</code></td>
4967 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4968 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4969 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4970 * </table></td>
4971 * </tr>
4972 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4973 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4974 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4975 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4976 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4977 * </table></td>
4978 * </tr>
4979 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4980 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4981 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4982 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4983 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4984 * </table></td>
4985 * </tr>
4986 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4987 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4988 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4989 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4990 * </table></td>
4991 * </tr>
4992 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4993 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4994 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4995 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4996 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4997 * </table></td>
4998 * </tr>
4999 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;<br />i.some_int=100;S.some_str=hello;end</code></td>
5000 * <td><table border="" style="margin:0" >
5001 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5002 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5003 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5004 * </table></td>
5005 * </tr>
5006 * </tbody>
5007 * </table>
5008 */
5009 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5010
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005011 /**
5012 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5013 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5014 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5015 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5016 * generated Intent can not cause unexpected data access to happen.
5017 *
5018 * <p>If you do not trust the source of the URI being parsed, you should still do further
5019 * processing to protect yourself from it. In particular, when using it to start an
5020 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5021 * that can handle it.</p>
5022 */
5023 public static final int URI_ALLOW_UNSAFE = 1<<2;
5024
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005025 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005026
5027 private String mAction;
5028 private Uri mData;
5029 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005030 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005031 private ComponentName mComponent;
5032 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005033 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005035 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005036 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005037 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005038 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005039
5040 // ---------------------------------------------------------------------
5041
5042 /**
5043 * Create an empty intent.
5044 */
5045 public Intent() {
5046 }
5047
5048 /**
5049 * Copy constructor.
5050 */
5051 public Intent(Intent o) {
5052 this.mAction = o.mAction;
5053 this.mData = o.mData;
5054 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005055 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005056 this.mComponent = o.mComponent;
5057 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005058 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005059 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005060 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005061 }
5062 if (o.mExtras != null) {
5063 this.mExtras = new Bundle(o.mExtras);
5064 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005065 if (o.mSourceBounds != null) {
5066 this.mSourceBounds = new Rect(o.mSourceBounds);
5067 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005068 if (o.mSelector != null) {
5069 this.mSelector = new Intent(o.mSelector);
5070 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005071 if (o.mClipData != null) {
5072 this.mClipData = new ClipData(o.mClipData);
5073 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 }
5075
5076 @Override
5077 public Object clone() {
5078 return new Intent(this);
5079 }
5080
5081 private Intent(Intent o, boolean all) {
5082 this.mAction = o.mAction;
5083 this.mData = o.mData;
5084 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005085 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005086 this.mComponent = o.mComponent;
5087 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005088 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005089 }
5090 }
5091
5092 /**
5093 * Make a clone of only the parts of the Intent that are relevant for
5094 * filter matching: the action, data, type, component, and categories.
5095 */
5096 public Intent cloneFilter() {
5097 return new Intent(this, false);
5098 }
5099
5100 /**
5101 * Create an intent with a given action. All other fields (data, type,
5102 * class) are null. Note that the action <em>must</em> be in a
5103 * namespace because Intents are used globally in the system -- for
5104 * example the system VIEW action is android.intent.action.VIEW; an
5105 * application's custom action would be something like
5106 * com.google.app.myapp.CUSTOM_ACTION.
5107 *
5108 * @param action The Intent action, such as ACTION_VIEW.
5109 */
5110 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005111 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 }
5113
5114 /**
5115 * Create an intent with a given action and for a given data url. Note
5116 * that the action <em>must</em> be in a namespace because Intents are
5117 * used globally in the system -- for example the system VIEW action is
5118 * android.intent.action.VIEW; an application's custom action would be
5119 * something like com.google.app.myapp.CUSTOM_ACTION.
5120 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005121 * <p><em>Note: scheme and host name matching in the Android framework is
5122 * case-sensitive, unlike the formal RFC. As a result,
5123 * you should always ensure that you write your Uri with these elements
5124 * using lower case letters, and normalize any Uris you receive from
5125 * outside of Android to ensure the scheme and host is lower case.</em></p>
5126 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005127 * @param action The Intent action, such as ACTION_VIEW.
5128 * @param uri The Intent data URI.
5129 */
5130 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005131 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005132 mData = uri;
5133 }
5134
5135 /**
5136 * Create an intent for a specific component. All other fields (action, data,
5137 * type, class) are null, though they can be modified later with explicit
5138 * calls. This provides a convenient way to create an intent that is
5139 * intended to execute a hard-coded class name, rather than relying on the
5140 * system to find an appropriate class for you; see {@link #setComponent}
5141 * for more information on the repercussions of this.
5142 *
5143 * @param packageContext A Context of the application package implementing
5144 * this class.
5145 * @param cls The component class that is to be used for the intent.
5146 *
5147 * @see #setClass
5148 * @see #setComponent
5149 * @see #Intent(String, android.net.Uri , Context, Class)
5150 */
5151 public Intent(Context packageContext, Class<?> cls) {
5152 mComponent = new ComponentName(packageContext, cls);
5153 }
5154
5155 /**
5156 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005157 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005158 * construct the Intent and then calling {@link #setClass} to set its
5159 * class.
5160 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005161 * <p><em>Note: scheme and host name matching in the Android framework is
5162 * case-sensitive, unlike the formal RFC. As a result,
5163 * you should always ensure that you write your Uri with these elements
5164 * using lower case letters, and normalize any Uris you receive from
5165 * outside of Android to ensure the scheme and host is lower case.</em></p>
5166 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005167 * @param action The Intent action, such as ACTION_VIEW.
5168 * @param uri The Intent data URI.
5169 * @param packageContext A Context of the application package implementing
5170 * this class.
5171 * @param cls The component class that is to be used for the intent.
5172 *
5173 * @see #Intent(String, android.net.Uri)
5174 * @see #Intent(Context, Class)
5175 * @see #setClass
5176 * @see #setComponent
5177 */
5178 public Intent(String action, Uri uri,
5179 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005180 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005181 mData = uri;
5182 mComponent = new ComponentName(packageContext, cls);
5183 }
5184
5185 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005186 * Create an intent to launch the main (root) activity of a task. This
5187 * is the Intent that is started when the application's is launched from
5188 * Home. For anything else that wants to launch an application in the
5189 * same way, it is important that they use an Intent structured the same
5190 * way, and can use this function to ensure this is the case.
5191 *
5192 * <p>The returned Intent has the given Activity component as its explicit
5193 * component, {@link #ACTION_MAIN} as its action, and includes the
5194 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5195 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5196 * to do that through {@link #addFlags(int)} on the returned Intent.
5197 *
5198 * @param mainActivity The main activity component that this Intent will
5199 * launch.
5200 * @return Returns a newly created Intent that can be used to launch the
5201 * activity as a main application entry.
5202 *
5203 * @see #setClass
5204 * @see #setComponent
5205 */
5206 public static Intent makeMainActivity(ComponentName mainActivity) {
5207 Intent intent = new Intent(ACTION_MAIN);
5208 intent.setComponent(mainActivity);
5209 intent.addCategory(CATEGORY_LAUNCHER);
5210 return intent;
5211 }
5212
5213 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005214 * Make an Intent for the main activity of an application, without
5215 * specifying a specific activity to run but giving a selector to find
5216 * the activity. This results in a final Intent that is structured
5217 * the same as when the application is launched from
5218 * Home. For anything else that wants to launch an application in the
5219 * same way, it is important that they use an Intent structured the same
5220 * way, and can use this function to ensure this is the case.
5221 *
5222 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5223 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5224 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5225 * to do that through {@link #addFlags(int)} on the returned Intent.
5226 *
5227 * @param selectorAction The action name of the Intent's selector.
5228 * @param selectorCategory The name of a category to add to the Intent's
5229 * selector.
5230 * @return Returns a newly created Intent that can be used to launch the
5231 * activity as a main application entry.
5232 *
5233 * @see #setSelector(Intent)
5234 */
5235 public static Intent makeMainSelectorActivity(String selectorAction,
5236 String selectorCategory) {
5237 Intent intent = new Intent(ACTION_MAIN);
5238 intent.addCategory(CATEGORY_LAUNCHER);
5239 Intent selector = new Intent();
5240 selector.setAction(selectorAction);
5241 selector.addCategory(selectorCategory);
5242 intent.setSelector(selector);
5243 return intent;
5244 }
5245
5246 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005247 * Make an Intent that can be used to re-launch an application's task
5248 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5249 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5250 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5251 *
5252 * @param mainActivity The activity component that is the root of the
5253 * task; this is the activity that has been published in the application's
5254 * manifest as the main launcher icon.
5255 *
5256 * @return Returns a newly created Intent that can be used to relaunch the
5257 * activity's task in its root state.
5258 */
5259 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5260 Intent intent = makeMainActivity(mainActivity);
5261 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5262 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5263 return intent;
5264 }
5265
5266 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005267 * Call {@link #parseUri} with 0 flags.
5268 * @deprecated Use {@link #parseUri} instead.
5269 */
5270 @Deprecated
5271 public static Intent getIntent(String uri) throws URISyntaxException {
5272 return parseUri(uri, 0);
5273 }
Tom Taylord4a47292009-12-21 13:59:18 -08005274
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005275 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005276 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005277 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005278 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005279 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005280 *
5281 * <p>The URI given here must not be relative -- that is, it must include
5282 * the scheme and full path.
5283 *
5284 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005285 * @param flags Additional processing flags. Either 0,
5286 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005287 *
5288 * @return Intent The newly created Intent object.
5289 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005290 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5291 * it bad (as parsed by the Uri class) or the Intent data within the
5292 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005293 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005294 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005295 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005296 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005297 int i = 0;
5298 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005299 final boolean androidApp = uri.startsWith("android-app:");
5300
5301 // Validate intent scheme if requested.
5302 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5303 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005304 Intent intent = new Intent(ACTION_VIEW);
5305 try {
5306 intent.setData(Uri.parse(uri));
5307 } catch (IllegalArgumentException e) {
5308 throw new URISyntaxException(uri, e.getMessage());
5309 }
5310 return intent;
5311 }
5312 }
Tom Taylord4a47292009-12-21 13:59:18 -08005313
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005314 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005315 // simple case
5316 if (i == -1) {
5317 if (!androidApp) {
5318 return new Intent(ACTION_VIEW, Uri.parse(uri));
5319 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005320
5321 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005322 } else if (!uri.startsWith("#Intent;", i)) {
5323 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005324 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005325 } else {
5326 i = -1;
5327 }
5328 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005329
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005330 // new format
5331 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005332 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005333 boolean explicitAction = false;
5334 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005335
5336 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005337 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005338 String data;
5339 if (i >= 0) {
5340 data = uri.substring(0, i);
5341 i += 8; // length of "#Intent;"
5342 } else {
5343 data = uri;
5344 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005345
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005346 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005347 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005348 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005349 if (eq < 0) eq = i-1;
5350 int semi = uri.indexOf(';', i);
5351 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005352
5353 // action
5354 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005355 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005356 if (!inSelector) {
5357 explicitAction = true;
5358 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005359 }
5360
5361 // categories
5362 else if (uri.startsWith("category=", i)) {
5363 intent.addCategory(value);
5364 }
5365
5366 // type
5367 else if (uri.startsWith("type=", i)) {
5368 intent.mType = value;
5369 }
5370
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005371 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005372 else if (uri.startsWith("launchFlags=", i)) {
5373 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005374 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5375 intent.mFlags &= ~IMMUTABLE_FLAGS;
5376 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005377 }
5378
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005379 // package
5380 else if (uri.startsWith("package=", i)) {
5381 intent.mPackage = value;
5382 }
5383
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005384 // component
5385 else if (uri.startsWith("component=", i)) {
5386 intent.mComponent = ComponentName.unflattenFromString(value);
5387 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005388
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005389 // scheme
5390 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005391 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005392 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005393 } else {
5394 scheme = value;
5395 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005396 }
5397
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005398 // source bounds
5399 else if (uri.startsWith("sourceBounds=", i)) {
5400 intent.mSourceBounds = Rect.unflattenFromString(value);
5401 }
5402
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005403 // selector
5404 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5405 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005406 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005407 }
5408
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005409 // extra
5410 else {
5411 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005412 // create Bundle if it doesn't already exist
5413 if (intent.mExtras == null) intent.mExtras = new Bundle();
5414 Bundle b = intent.mExtras;
5415 // add EXTRA
5416 if (uri.startsWith("S.", i)) b.putString(key, value);
5417 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5418 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5419 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5420 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5421 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5422 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5423 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5424 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5425 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5426 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005427
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005428 // move to the next item
5429 i = semi + 1;
5430 }
5431
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005432 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005433 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005434 if (baseIntent.mPackage == null) {
5435 baseIntent.setSelector(intent);
5436 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005437 intent = baseIntent;
5438 }
5439
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005440 if (data != null) {
5441 if (data.startsWith("intent:")) {
5442 data = data.substring(7);
5443 if (scheme != null) {
5444 data = scheme + ':' + data;
5445 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005446 } else if (data.startsWith("android-app:")) {
5447 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5448 // Correctly formed android-app, first part is package name.
5449 int end = data.indexOf('/', 14);
5450 if (end < 0) {
5451 // All we have is a package name.
5452 intent.mPackage = data.substring(14);
5453 if (!explicitAction) {
5454 intent.setAction(ACTION_MAIN);
5455 }
5456 data = "";
5457 } else {
5458 // Target the Intent at the given package name always.
5459 String authority = null;
5460 intent.mPackage = data.substring(14, end);
5461 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005462 if ((end+1) < data.length()) {
5463 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5464 // Found a scheme, remember it.
5465 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005466 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005467 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5468 // Found a authority, remember it.
5469 authority = data.substring(end+1, newEnd);
5470 end = newEnd;
5471 }
5472 } else {
5473 // All we have is a scheme.
5474 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005475 }
5476 }
5477 if (scheme == null) {
5478 // If there was no scheme, then this just targets the package.
5479 if (!explicitAction) {
5480 intent.setAction(ACTION_MAIN);
5481 }
5482 data = "";
5483 } else if (authority == null) {
5484 data = scheme + ":";
5485 } else {
5486 data = scheme + "://" + authority + data.substring(end);
5487 }
5488 }
5489 } else {
5490 data = "";
5491 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005492 }
Tom Taylord4a47292009-12-21 13:59:18 -08005493
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005494 if (data.length() > 0) {
5495 try {
5496 intent.mData = Uri.parse(data);
5497 } catch (IllegalArgumentException e) {
5498 throw new URISyntaxException(uri, e.getMessage());
5499 }
5500 }
5501 }
Tom Taylord4a47292009-12-21 13:59:18 -08005502
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005503 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005504
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005505 } catch (IndexOutOfBoundsException e) {
5506 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5507 }
5508 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005509
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005510 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005511 return getIntentOld(uri, 0);
5512 }
5513
5514 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005515 Intent intent;
5516
5517 int i = uri.lastIndexOf('#');
5518 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005519 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005520 final int intentFragmentStart = i;
5521 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005522
5523 i++;
5524
5525 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005526 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005527 i += 7;
5528 int j = uri.indexOf(')', i);
5529 action = uri.substring(i, j);
5530 i = j + 1;
5531 }
5532
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005533 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005534
5535 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005536 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005537 i += 11;
5538 int j = uri.indexOf(')', i);
5539 while (i < j) {
5540 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005541 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005542 if (i < sep) {
5543 intent.addCategory(uri.substring(i, sep));
5544 }
5545 i = sep + 1;
5546 }
5547 i = j + 1;
5548 }
5549
5550 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005551 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005552 i += 5;
5553 int j = uri.indexOf(')', i);
5554 intent.mType = uri.substring(i, j);
5555 i = j + 1;
5556 }
5557
5558 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005559 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005560 i += 12;
5561 int j = uri.indexOf(')', i);
5562 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005563 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5564 intent.mFlags &= ~IMMUTABLE_FLAGS;
5565 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005566 i = j + 1;
5567 }
5568
5569 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005570 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005571 i += 10;
5572 int j = uri.indexOf(')', i);
5573 int sep = uri.indexOf('!', i);
5574 if (sep >= 0 && sep < j) {
5575 String pkg = uri.substring(i, sep);
5576 String cls = uri.substring(sep + 1, j);
5577 intent.mComponent = new ComponentName(pkg, cls);
5578 }
5579 i = j + 1;
5580 }
5581
5582 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005583 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005584 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005585
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005586 final int closeParen = uri.indexOf(')', i);
5587 if (closeParen == -1) throw new URISyntaxException(uri,
5588 "EXTRA missing trailing ')'", i);
5589
5590 while (i < closeParen) {
5591 // fetch the key value
5592 int j = uri.indexOf('=', i);
5593 if (j <= i + 1 || i >= closeParen) {
5594 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5595 }
5596 char type = uri.charAt(i);
5597 i++;
5598 String key = uri.substring(i, j);
5599 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005600
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005601 // get type-value
5602 j = uri.indexOf('!', i);
5603 if (j == -1 || j >= closeParen) j = closeParen;
5604 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5605 String value = uri.substring(i, j);
5606 i = j;
5607
5608 // create Bundle if it doesn't already exist
5609 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005610
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005611 // add item to bundle
5612 try {
5613 switch (type) {
5614 case 'S':
5615 intent.mExtras.putString(key, Uri.decode(value));
5616 break;
5617 case 'B':
5618 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5619 break;
5620 case 'b':
5621 intent.mExtras.putByte(key, Byte.parseByte(value));
5622 break;
5623 case 'c':
5624 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5625 break;
5626 case 'd':
5627 intent.mExtras.putDouble(key, Double.parseDouble(value));
5628 break;
5629 case 'f':
5630 intent.mExtras.putFloat(key, Float.parseFloat(value));
5631 break;
5632 case 'i':
5633 intent.mExtras.putInt(key, Integer.parseInt(value));
5634 break;
5635 case 'l':
5636 intent.mExtras.putLong(key, Long.parseLong(value));
5637 break;
5638 case 's':
5639 intent.mExtras.putShort(key, Short.parseShort(value));
5640 break;
5641 default:
5642 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5643 }
5644 } catch (NumberFormatException e) {
5645 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5646 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005647
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005648 char ch = uri.charAt(i);
5649 if (ch == ')') break;
5650 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5651 i++;
5652 }
5653 }
5654
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005655 if (isIntentFragment) {
5656 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5657 } else {
5658 intent.mData = Uri.parse(uri);
5659 }
Tom Taylord4a47292009-12-21 13:59:18 -08005660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005661 if (intent.mAction == null) {
5662 // By default, if no action is specified, then use VIEW.
5663 intent.mAction = ACTION_VIEW;
5664 }
5665
5666 } else {
5667 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5668 }
5669
5670 return intent;
5671 }
5672
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005673 /** @hide */
5674 public interface CommandOptionHandler {
5675 boolean handleOption(String opt, ShellCommand cmd);
5676 }
5677
5678 /** @hide */
5679 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5680 throws URISyntaxException {
5681 Intent intent = new Intent();
5682 Intent baseIntent = intent;
5683 boolean hasIntentInfo = false;
5684
5685 Uri data = null;
5686 String type = null;
5687
5688 String opt;
5689 while ((opt=cmd.getNextOption()) != null) {
5690 switch (opt) {
5691 case "-a":
5692 intent.setAction(cmd.getNextArgRequired());
5693 if (intent == baseIntent) {
5694 hasIntentInfo = true;
5695 }
5696 break;
5697 case "-d":
5698 data = Uri.parse(cmd.getNextArgRequired());
5699 if (intent == baseIntent) {
5700 hasIntentInfo = true;
5701 }
5702 break;
5703 case "-t":
5704 type = cmd.getNextArgRequired();
5705 if (intent == baseIntent) {
5706 hasIntentInfo = true;
5707 }
5708 break;
5709 case "-c":
5710 intent.addCategory(cmd.getNextArgRequired());
5711 if (intent == baseIntent) {
5712 hasIntentInfo = true;
5713 }
5714 break;
5715 case "-e":
5716 case "--es": {
5717 String key = cmd.getNextArgRequired();
5718 String value = cmd.getNextArgRequired();
5719 intent.putExtra(key, value);
5720 }
5721 break;
5722 case "--esn": {
5723 String key = cmd.getNextArgRequired();
5724 intent.putExtra(key, (String) null);
5725 }
5726 break;
5727 case "--ei": {
5728 String key = cmd.getNextArgRequired();
5729 String value = cmd.getNextArgRequired();
5730 intent.putExtra(key, Integer.decode(value));
5731 }
5732 break;
5733 case "--eu": {
5734 String key = cmd.getNextArgRequired();
5735 String value = cmd.getNextArgRequired();
5736 intent.putExtra(key, Uri.parse(value));
5737 }
5738 break;
5739 case "--ecn": {
5740 String key = cmd.getNextArgRequired();
5741 String value = cmd.getNextArgRequired();
5742 ComponentName cn = ComponentName.unflattenFromString(value);
5743 if (cn == null)
5744 throw new IllegalArgumentException("Bad component name: " + value);
5745 intent.putExtra(key, cn);
5746 }
5747 break;
5748 case "--eia": {
5749 String key = cmd.getNextArgRequired();
5750 String value = cmd.getNextArgRequired();
5751 String[] strings = value.split(",");
5752 int[] list = new int[strings.length];
5753 for (int i = 0; i < strings.length; i++) {
5754 list[i] = Integer.decode(strings[i]);
5755 }
5756 intent.putExtra(key, list);
5757 }
5758 break;
5759 case "--eial": {
5760 String key = cmd.getNextArgRequired();
5761 String value = cmd.getNextArgRequired();
5762 String[] strings = value.split(",");
5763 ArrayList<Integer> list = new ArrayList<>(strings.length);
5764 for (int i = 0; i < strings.length; i++) {
5765 list.add(Integer.decode(strings[i]));
5766 }
5767 intent.putExtra(key, list);
5768 }
5769 break;
5770 case "--el": {
5771 String key = cmd.getNextArgRequired();
5772 String value = cmd.getNextArgRequired();
5773 intent.putExtra(key, Long.valueOf(value));
5774 }
5775 break;
5776 case "--ela": {
5777 String key = cmd.getNextArgRequired();
5778 String value = cmd.getNextArgRequired();
5779 String[] strings = value.split(",");
5780 long[] list = new long[strings.length];
5781 for (int i = 0; i < strings.length; i++) {
5782 list[i] = Long.valueOf(strings[i]);
5783 }
5784 intent.putExtra(key, list);
5785 hasIntentInfo = true;
5786 }
5787 break;
5788 case "--elal": {
5789 String key = cmd.getNextArgRequired();
5790 String value = cmd.getNextArgRequired();
5791 String[] strings = value.split(",");
5792 ArrayList<Long> list = new ArrayList<>(strings.length);
5793 for (int i = 0; i < strings.length; i++) {
5794 list.add(Long.valueOf(strings[i]));
5795 }
5796 intent.putExtra(key, list);
5797 hasIntentInfo = true;
5798 }
5799 break;
5800 case "--ef": {
5801 String key = cmd.getNextArgRequired();
5802 String value = cmd.getNextArgRequired();
5803 intent.putExtra(key, Float.valueOf(value));
5804 hasIntentInfo = true;
5805 }
5806 break;
5807 case "--efa": {
5808 String key = cmd.getNextArgRequired();
5809 String value = cmd.getNextArgRequired();
5810 String[] strings = value.split(",");
5811 float[] list = new float[strings.length];
5812 for (int i = 0; i < strings.length; i++) {
5813 list[i] = Float.valueOf(strings[i]);
5814 }
5815 intent.putExtra(key, list);
5816 hasIntentInfo = true;
5817 }
5818 break;
5819 case "--efal": {
5820 String key = cmd.getNextArgRequired();
5821 String value = cmd.getNextArgRequired();
5822 String[] strings = value.split(",");
5823 ArrayList<Float> list = new ArrayList<>(strings.length);
5824 for (int i = 0; i < strings.length; i++) {
5825 list.add(Float.valueOf(strings[i]));
5826 }
5827 intent.putExtra(key, list);
5828 hasIntentInfo = true;
5829 }
5830 break;
5831 case "--esa": {
5832 String key = cmd.getNextArgRequired();
5833 String value = cmd.getNextArgRequired();
5834 // Split on commas unless they are preceeded by an escape.
5835 // The escape character must be escaped for the string and
5836 // again for the regex, thus four escape characters become one.
5837 String[] strings = value.split("(?<!\\\\),");
5838 intent.putExtra(key, strings);
5839 hasIntentInfo = true;
5840 }
5841 break;
5842 case "--esal": {
5843 String key = cmd.getNextArgRequired();
5844 String value = cmd.getNextArgRequired();
5845 // Split on commas unless they are preceeded by an escape.
5846 // The escape character must be escaped for the string and
5847 // again for the regex, thus four escape characters become one.
5848 String[] strings = value.split("(?<!\\\\),");
5849 ArrayList<String> list = new ArrayList<>(strings.length);
5850 for (int i = 0; i < strings.length; i++) {
5851 list.add(strings[i]);
5852 }
5853 intent.putExtra(key, list);
5854 hasIntentInfo = true;
5855 }
5856 break;
5857 case "--ez": {
5858 String key = cmd.getNextArgRequired();
5859 String value = cmd.getNextArgRequired().toLowerCase();
5860 // Boolean.valueOf() results in false for anything that is not "true", which is
5861 // error-prone in shell commands
5862 boolean arg;
5863 if ("true".equals(value) || "t".equals(value)) {
5864 arg = true;
5865 } else if ("false".equals(value) || "f".equals(value)) {
5866 arg = false;
5867 } else {
5868 try {
5869 arg = Integer.decode(value) != 0;
5870 } catch (NumberFormatException ex) {
5871 throw new IllegalArgumentException("Invalid boolean value: " + value);
5872 }
5873 }
5874
5875 intent.putExtra(key, arg);
5876 }
5877 break;
5878 case "-n": {
5879 String str = cmd.getNextArgRequired();
5880 ComponentName cn = ComponentName.unflattenFromString(str);
5881 if (cn == null)
5882 throw new IllegalArgumentException("Bad component name: " + str);
5883 intent.setComponent(cn);
5884 if (intent == baseIntent) {
5885 hasIntentInfo = true;
5886 }
5887 }
5888 break;
5889 case "-p": {
5890 String str = cmd.getNextArgRequired();
5891 intent.setPackage(str);
5892 if (intent == baseIntent) {
5893 hasIntentInfo = true;
5894 }
5895 }
5896 break;
5897 case "-f":
5898 String str = cmd.getNextArgRequired();
5899 intent.setFlags(Integer.decode(str).intValue());
5900 break;
5901 case "--grant-read-uri-permission":
5902 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5903 break;
5904 case "--grant-write-uri-permission":
5905 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5906 break;
5907 case "--grant-persistable-uri-permission":
5908 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5909 break;
5910 case "--grant-prefix-uri-permission":
5911 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5912 break;
5913 case "--exclude-stopped-packages":
5914 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5915 break;
5916 case "--include-stopped-packages":
5917 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5918 break;
5919 case "--debug-log-resolution":
5920 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5921 break;
5922 case "--activity-brought-to-front":
5923 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5924 break;
5925 case "--activity-clear-top":
5926 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5927 break;
5928 case "--activity-clear-when-task-reset":
5929 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5930 break;
5931 case "--activity-exclude-from-recents":
5932 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5933 break;
5934 case "--activity-launched-from-history":
5935 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5936 break;
5937 case "--activity-multiple-task":
5938 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5939 break;
5940 case "--activity-no-animation":
5941 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5942 break;
5943 case "--activity-no-history":
5944 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5945 break;
5946 case "--activity-no-user-action":
5947 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5948 break;
5949 case "--activity-previous-is-top":
5950 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5951 break;
5952 case "--activity-reorder-to-front":
5953 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5954 break;
5955 case "--activity-reset-task-if-needed":
5956 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5957 break;
5958 case "--activity-single-top":
5959 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5960 break;
5961 case "--activity-clear-task":
5962 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5963 break;
5964 case "--activity-task-on-home":
5965 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5966 break;
5967 case "--receiver-registered-only":
5968 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5969 break;
5970 case "--receiver-replace-pending":
5971 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5972 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005973 case "--receiver-foreground":
5974 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5975 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005976 case "--selector":
5977 intent.setDataAndType(data, type);
5978 intent = new Intent();
5979 break;
5980 default:
5981 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5982 // Okay, caller handled this option.
5983 } else {
5984 throw new IllegalArgumentException("Unknown option: " + opt);
5985 }
5986 break;
5987 }
5988 }
5989 intent.setDataAndType(data, type);
5990
5991 final boolean hasSelector = intent != baseIntent;
5992 if (hasSelector) {
5993 // A selector was specified; fix up.
5994 baseIntent.setSelector(intent);
5995 intent = baseIntent;
5996 }
5997
5998 String arg = cmd.getNextArg();
5999 baseIntent = null;
6000 if (arg == null) {
6001 if (hasSelector) {
6002 // If a selector has been specified, and no arguments
6003 // have been supplied for the main Intent, then we can
6004 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6005 // need to have a component name specified yet, the
6006 // selector will take care of that.
6007 baseIntent = new Intent(Intent.ACTION_MAIN);
6008 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6009 }
6010 } else if (arg.indexOf(':') >= 0) {
6011 // The argument is a URI. Fully parse it, and use that result
6012 // to fill in any data not specified so far.
6013 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6014 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6015 } else if (arg.indexOf('/') >= 0) {
6016 // The argument is a component name. Build an Intent to launch
6017 // it.
6018 baseIntent = new Intent(Intent.ACTION_MAIN);
6019 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6020 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6021 } else {
6022 // Assume the argument is a package name.
6023 baseIntent = new Intent(Intent.ACTION_MAIN);
6024 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6025 baseIntent.setPackage(arg);
6026 }
6027 if (baseIntent != null) {
6028 Bundle extras = intent.getExtras();
6029 intent.replaceExtras((Bundle)null);
6030 Bundle uriExtras = baseIntent.getExtras();
6031 baseIntent.replaceExtras((Bundle)null);
6032 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6033 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6034 for (String c : cats) {
6035 baseIntent.removeCategory(c);
6036 }
6037 }
6038 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6039 if (extras == null) {
6040 extras = uriExtras;
6041 } else if (uriExtras != null) {
6042 uriExtras.putAll(extras);
6043 extras = uriExtras;
6044 }
6045 intent.replaceExtras(extras);
6046 hasIntentInfo = true;
6047 }
6048
6049 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6050 return intent;
6051 }
6052
6053 /** @hide */
6054 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6055 final String[] lines = new String[] {
6056 "<INTENT> specifications include these flags and arguments:",
6057 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6058 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6059 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6060 " [--esn <EXTRA_KEY> ...]",
6061 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6062 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6063 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6064 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6065 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6066 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6067 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6068 " (mutiple extras passed as Integer[])",
6069 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6070 " (mutiple extras passed as List<Integer>)",
6071 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6072 " (mutiple extras passed as Long[])",
6073 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6074 " (mutiple extras passed as List<Long>)",
6075 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6076 " (mutiple extras passed as Float[])",
6077 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6078 " (mutiple extras passed as List<Float>)",
6079 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6080 " (mutiple extras passed as String[]; to embed a comma into a string,",
6081 " escape it using \"\\,\")",
6082 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6083 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6084 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006085 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006086 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6087 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6088 " [--debug-log-resolution] [--exclude-stopped-packages]",
6089 " [--include-stopped-packages]",
6090 " [--activity-brought-to-front] [--activity-clear-top]",
6091 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6092 " [--activity-launched-from-history] [--activity-multiple-task]",
6093 " [--activity-no-animation] [--activity-no-history]",
6094 " [--activity-no-user-action] [--activity-previous-is-top]",
6095 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6096 " [--activity-single-top] [--activity-clear-task]",
6097 " [--activity-task-on-home]",
6098 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006099 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006100 " [--selector]",
6101 " [<URI> | <PACKAGE> | <COMPONENT>]"
6102 };
6103 for (String line : lines) {
6104 pw.print(prefix);
6105 pw.println(line);
6106 }
6107 }
6108
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006109 /**
6110 * Retrieve the general action to be performed, such as
6111 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6112 * the information in the intent should be interpreted -- most importantly,
6113 * what to do with the data returned by {@link #getData}.
6114 *
6115 * @return The action of this intent or null if none is specified.
6116 *
6117 * @see #setAction
6118 */
6119 public String getAction() {
6120 return mAction;
6121 }
6122
6123 /**
6124 * Retrieve data this intent is operating on. This URI specifies the name
6125 * of the data; often it uses the content: scheme, specifying data in a
6126 * content provider. Other schemes may be handled by specific activities,
6127 * such as http: by the web browser.
6128 *
6129 * @return The URI of the data this intent is targeting or null.
6130 *
6131 * @see #getScheme
6132 * @see #setData
6133 */
6134 public Uri getData() {
6135 return mData;
6136 }
6137
6138 /**
6139 * The same as {@link #getData()}, but returns the URI as an encoded
6140 * String.
6141 */
6142 public String getDataString() {
6143 return mData != null ? mData.toString() : null;
6144 }
6145
6146 /**
6147 * Return the scheme portion of the intent's data. If the data is null or
6148 * does not include a scheme, null is returned. Otherwise, the scheme
6149 * prefix without the final ':' is returned, i.e. "http".
6150 *
6151 * <p>This is the same as calling getData().getScheme() (and checking for
6152 * null data).
6153 *
6154 * @return The scheme of this intent.
6155 *
6156 * @see #getData
6157 */
6158 public String getScheme() {
6159 return mData != null ? mData.getScheme() : null;
6160 }
6161
6162 /**
6163 * Retrieve any explicit MIME type included in the intent. This is usually
6164 * null, as the type is determined by the intent data.
6165 *
6166 * @return If a type was manually set, it is returned; else null is
6167 * returned.
6168 *
6169 * @see #resolveType(ContentResolver)
6170 * @see #setType
6171 */
6172 public String getType() {
6173 return mType;
6174 }
6175
6176 /**
6177 * Return the MIME data type of this intent. If the type field is
6178 * explicitly set, that is simply returned. Otherwise, if the data is set,
6179 * the type of that data is returned. If neither fields are set, a null is
6180 * returned.
6181 *
6182 * @return The MIME type of this intent.
6183 *
6184 * @see #getType
6185 * @see #resolveType(ContentResolver)
6186 */
6187 public String resolveType(Context context) {
6188 return resolveType(context.getContentResolver());
6189 }
6190
6191 /**
6192 * Return the MIME data type of this intent. If the type field is
6193 * explicitly set, that is simply returned. Otherwise, if the data is set,
6194 * the type of that data is returned. If neither fields are set, a null is
6195 * returned.
6196 *
6197 * @param resolver A ContentResolver that can be used to determine the MIME
6198 * type of the intent's data.
6199 *
6200 * @return The MIME type of this intent.
6201 *
6202 * @see #getType
6203 * @see #resolveType(Context)
6204 */
6205 public String resolveType(ContentResolver resolver) {
6206 if (mType != null) {
6207 return mType;
6208 }
6209 if (mData != null) {
6210 if ("content".equals(mData.getScheme())) {
6211 return resolver.getType(mData);
6212 }
6213 }
6214 return null;
6215 }
6216
6217 /**
6218 * Return the MIME data type of this intent, only if it will be needed for
6219 * intent resolution. This is not generally useful for application code;
6220 * it is used by the frameworks for communicating with back-end system
6221 * services.
6222 *
6223 * @param resolver A ContentResolver that can be used to determine the MIME
6224 * type of the intent's data.
6225 *
6226 * @return The MIME type of this intent, or null if it is unknown or not
6227 * needed.
6228 */
6229 public String resolveTypeIfNeeded(ContentResolver resolver) {
6230 if (mComponent != null) {
6231 return mType;
6232 }
6233 return resolveType(resolver);
6234 }
6235
6236 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006237 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006238 *
6239 * @param category The category to check.
6240 *
6241 * @return boolean True if the intent contains the category, else false.
6242 *
6243 * @see #getCategories
6244 * @see #addCategory
6245 */
6246 public boolean hasCategory(String category) {
6247 return mCategories != null && mCategories.contains(category);
6248 }
6249
6250 /**
6251 * Return the set of all categories in the intent. If there are no categories,
6252 * returns NULL.
6253 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006254 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006255 *
6256 * @see #hasCategory
6257 * @see #addCategory
6258 */
6259 public Set<String> getCategories() {
6260 return mCategories;
6261 }
6262
6263 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006264 * Return the specific selector associated with this Intent. If there is
6265 * none, returns null. See {@link #setSelector} for more information.
6266 *
6267 * @see #setSelector
6268 */
6269 public Intent getSelector() {
6270 return mSelector;
6271 }
6272
6273 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006274 * Return the {@link ClipData} associated with this Intent. If there is
6275 * none, returns null. See {@link #setClipData} for more information.
6276 *
John Spurlock125d1332013-11-25 11:58:37 -05006277 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006278 */
6279 public ClipData getClipData() {
6280 return mClipData;
6281 }
6282
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006283 /** @hide */
6284 public int getContentUserHint() {
6285 return mContentUserHint;
6286 }
6287
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006288 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006289 * Sets the ClassLoader that will be used when unmarshalling
6290 * any Parcelable values from the extras of this Intent.
6291 *
6292 * @param loader a ClassLoader, or null to use the default loader
6293 * at the time of unmarshalling.
6294 */
6295 public void setExtrasClassLoader(ClassLoader loader) {
6296 if (mExtras != null) {
6297 mExtras.setClassLoader(loader);
6298 }
6299 }
6300
6301 /**
6302 * Returns true if an extra value is associated with the given name.
6303 * @param name the extra's name
6304 * @return true if the given extra is present.
6305 */
6306 public boolean hasExtra(String name) {
6307 return mExtras != null && mExtras.containsKey(name);
6308 }
6309
6310 /**
6311 * Returns true if the Intent's extras contain a parcelled file descriptor.
6312 * @return true if the Intent contains a parcelled file descriptor.
6313 */
6314 public boolean hasFileDescriptors() {
6315 return mExtras != null && mExtras.hasFileDescriptors();
6316 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006317
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006318 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006319 public void setAllowFds(boolean allowFds) {
6320 if (mExtras != null) {
6321 mExtras.setAllowFds(allowFds);
6322 }
6323 }
6324
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006325 /** {@hide} */
6326 public void setDefusable(boolean defusable) {
6327 if (mExtras != null) {
6328 mExtras.setDefusable(defusable);
6329 }
6330 }
6331
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006332 /**
6333 * Retrieve extended data from the intent.
6334 *
6335 * @param name The name of the desired item.
6336 *
6337 * @return the value of an item that previously added with putExtra()
6338 * or null if none was found.
6339 *
6340 * @deprecated
6341 * @hide
6342 */
6343 @Deprecated
6344 public Object getExtra(String name) {
6345 return getExtra(name, null);
6346 }
6347
6348 /**
6349 * Retrieve extended data from the intent.
6350 *
6351 * @param name The name of the desired item.
6352 * @param defaultValue the value to be returned if no value of the desired
6353 * type is stored with the given name.
6354 *
6355 * @return the value of an item that previously added with putExtra()
6356 * or the default value if none was found.
6357 *
6358 * @see #putExtra(String, boolean)
6359 */
6360 public boolean getBooleanExtra(String name, boolean defaultValue) {
6361 return mExtras == null ? defaultValue :
6362 mExtras.getBoolean(name, defaultValue);
6363 }
6364
6365 /**
6366 * Retrieve extended data from the intent.
6367 *
6368 * @param name The name of the desired item.
6369 * @param defaultValue the value to be returned if no value of the desired
6370 * type is stored with the given name.
6371 *
6372 * @return the value of an item that previously added with putExtra()
6373 * or the default value if none was found.
6374 *
6375 * @see #putExtra(String, byte)
6376 */
6377 public byte getByteExtra(String name, byte defaultValue) {
6378 return mExtras == null ? defaultValue :
6379 mExtras.getByte(name, defaultValue);
6380 }
6381
6382 /**
6383 * Retrieve extended data from the intent.
6384 *
6385 * @param name The name of the desired item.
6386 * @param defaultValue the value to be returned if no value of the desired
6387 * type is stored with the given name.
6388 *
6389 * @return the value of an item that previously added with putExtra()
6390 * or the default value if none was found.
6391 *
6392 * @see #putExtra(String, short)
6393 */
6394 public short getShortExtra(String name, short defaultValue) {
6395 return mExtras == null ? defaultValue :
6396 mExtras.getShort(name, defaultValue);
6397 }
6398
6399 /**
6400 * Retrieve extended data from the intent.
6401 *
6402 * @param name The name of the desired item.
6403 * @param defaultValue the value to be returned if no value of the desired
6404 * type is stored with the given name.
6405 *
6406 * @return the value of an item that previously added with putExtra()
6407 * or the default value if none was found.
6408 *
6409 * @see #putExtra(String, char)
6410 */
6411 public char getCharExtra(String name, char defaultValue) {
6412 return mExtras == null ? defaultValue :
6413 mExtras.getChar(name, defaultValue);
6414 }
6415
6416 /**
6417 * Retrieve extended data from the intent.
6418 *
6419 * @param name The name of the desired item.
6420 * @param defaultValue the value to be returned if no value of the desired
6421 * type is stored with the given name.
6422 *
6423 * @return the value of an item that previously added with putExtra()
6424 * or the default value if none was found.
6425 *
6426 * @see #putExtra(String, int)
6427 */
6428 public int getIntExtra(String name, int defaultValue) {
6429 return mExtras == null ? defaultValue :
6430 mExtras.getInt(name, defaultValue);
6431 }
6432
6433 /**
6434 * Retrieve extended data from the intent.
6435 *
6436 * @param name The name of the desired item.
6437 * @param defaultValue the value to be returned if no value of the desired
6438 * type is stored with the given name.
6439 *
6440 * @return the value of an item that previously added with putExtra()
6441 * or the default value if none was found.
6442 *
6443 * @see #putExtra(String, long)
6444 */
6445 public long getLongExtra(String name, long defaultValue) {
6446 return mExtras == null ? defaultValue :
6447 mExtras.getLong(name, defaultValue);
6448 }
6449
6450 /**
6451 * Retrieve extended data from the intent.
6452 *
6453 * @param name The name of the desired item.
6454 * @param defaultValue the value to be returned if no value of the desired
6455 * type is stored with the given name.
6456 *
6457 * @return the value of an item that previously added with putExtra(),
6458 * or the default value if no such item is present
6459 *
6460 * @see #putExtra(String, float)
6461 */
6462 public float getFloatExtra(String name, float defaultValue) {
6463 return mExtras == null ? defaultValue :
6464 mExtras.getFloat(name, defaultValue);
6465 }
6466
6467 /**
6468 * Retrieve extended data from the intent.
6469 *
6470 * @param name The name of the desired item.
6471 * @param defaultValue the value to be returned if no value of the desired
6472 * type is stored with the given name.
6473 *
6474 * @return the value of an item that previously added with putExtra()
6475 * or the default value if none was found.
6476 *
6477 * @see #putExtra(String, double)
6478 */
6479 public double getDoubleExtra(String name, double defaultValue) {
6480 return mExtras == null ? defaultValue :
6481 mExtras.getDouble(name, defaultValue);
6482 }
6483
6484 /**
6485 * Retrieve extended data from the intent.
6486 *
6487 * @param name The name of the desired item.
6488 *
6489 * @return the value of an item that previously added with putExtra()
6490 * or null if no String value was found.
6491 *
6492 * @see #putExtra(String, String)
6493 */
6494 public String getStringExtra(String name) {
6495 return mExtras == null ? null : mExtras.getString(name);
6496 }
6497
6498 /**
6499 * Retrieve extended data from the intent.
6500 *
6501 * @param name The name of the desired item.
6502 *
6503 * @return the value of an item that previously added with putExtra()
6504 * or null if no CharSequence value was found.
6505 *
6506 * @see #putExtra(String, CharSequence)
6507 */
6508 public CharSequence getCharSequenceExtra(String name) {
6509 return mExtras == null ? null : mExtras.getCharSequence(name);
6510 }
6511
6512 /**
6513 * Retrieve extended data from the intent.
6514 *
6515 * @param name The name of the desired item.
6516 *
6517 * @return the value of an item that previously added with putExtra()
6518 * or null if no Parcelable value was found.
6519 *
6520 * @see #putExtra(String, Parcelable)
6521 */
6522 public <T extends Parcelable> T getParcelableExtra(String name) {
6523 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6524 }
6525
6526 /**
6527 * Retrieve extended data from the intent.
6528 *
6529 * @param name The name of the desired item.
6530 *
6531 * @return the value of an item that previously added with putExtra()
6532 * or null if no Parcelable[] value was found.
6533 *
6534 * @see #putExtra(String, Parcelable[])
6535 */
6536 public Parcelable[] getParcelableArrayExtra(String name) {
6537 return mExtras == null ? null : mExtras.getParcelableArray(name);
6538 }
6539
6540 /**
6541 * Retrieve extended data from the intent.
6542 *
6543 * @param name The name of the desired item.
6544 *
6545 * @return the value of an item that previously added with putExtra()
6546 * or null if no ArrayList<Parcelable> value was found.
6547 *
6548 * @see #putParcelableArrayListExtra(String, ArrayList)
6549 */
6550 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6551 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6552 }
6553
6554 /**
6555 * Retrieve extended data from the intent.
6556 *
6557 * @param name The name of the desired item.
6558 *
6559 * @return the value of an item that previously added with putExtra()
6560 * or null if no Serializable value was found.
6561 *
6562 * @see #putExtra(String, Serializable)
6563 */
6564 public Serializable getSerializableExtra(String name) {
6565 return mExtras == null ? null : mExtras.getSerializable(name);
6566 }
6567
6568 /**
6569 * Retrieve extended data from the intent.
6570 *
6571 * @param name The name of the desired item.
6572 *
6573 * @return the value of an item that previously added with putExtra()
6574 * or null if no ArrayList<Integer> value was found.
6575 *
6576 * @see #putIntegerArrayListExtra(String, ArrayList)
6577 */
6578 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6579 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6580 }
6581
6582 /**
6583 * Retrieve extended data from the intent.
6584 *
6585 * @param name The name of the desired item.
6586 *
6587 * @return the value of an item that previously added with putExtra()
6588 * or null if no ArrayList<String> value was found.
6589 *
6590 * @see #putStringArrayListExtra(String, ArrayList)
6591 */
6592 public ArrayList<String> getStringArrayListExtra(String name) {
6593 return mExtras == null ? null : mExtras.getStringArrayList(name);
6594 }
6595
6596 /**
6597 * Retrieve extended data from the intent.
6598 *
6599 * @param name The name of the desired item.
6600 *
6601 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006602 * or null if no ArrayList<CharSequence> value was found.
6603 *
6604 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6605 */
6606 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6607 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6608 }
6609
6610 /**
6611 * Retrieve extended data from the intent.
6612 *
6613 * @param name The name of the desired item.
6614 *
6615 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006616 * or null if no boolean array value was found.
6617 *
6618 * @see #putExtra(String, boolean[])
6619 */
6620 public boolean[] getBooleanArrayExtra(String name) {
6621 return mExtras == null ? null : mExtras.getBooleanArray(name);
6622 }
6623
6624 /**
6625 * Retrieve extended data from the intent.
6626 *
6627 * @param name The name of the desired item.
6628 *
6629 * @return the value of an item that previously added with putExtra()
6630 * or null if no byte array value was found.
6631 *
6632 * @see #putExtra(String, byte[])
6633 */
6634 public byte[] getByteArrayExtra(String name) {
6635 return mExtras == null ? null : mExtras.getByteArray(name);
6636 }
6637
6638 /**
6639 * Retrieve extended data from the intent.
6640 *
6641 * @param name The name of the desired item.
6642 *
6643 * @return the value of an item that previously added with putExtra()
6644 * or null if no short array value was found.
6645 *
6646 * @see #putExtra(String, short[])
6647 */
6648 public short[] getShortArrayExtra(String name) {
6649 return mExtras == null ? null : mExtras.getShortArray(name);
6650 }
6651
6652 /**
6653 * Retrieve extended data from the intent.
6654 *
6655 * @param name The name of the desired item.
6656 *
6657 * @return the value of an item that previously added with putExtra()
6658 * or null if no char array value was found.
6659 *
6660 * @see #putExtra(String, char[])
6661 */
6662 public char[] getCharArrayExtra(String name) {
6663 return mExtras == null ? null : mExtras.getCharArray(name);
6664 }
6665
6666 /**
6667 * Retrieve extended data from the intent.
6668 *
6669 * @param name The name of the desired item.
6670 *
6671 * @return the value of an item that previously added with putExtra()
6672 * or null if no int array value was found.
6673 *
6674 * @see #putExtra(String, int[])
6675 */
6676 public int[] getIntArrayExtra(String name) {
6677 return mExtras == null ? null : mExtras.getIntArray(name);
6678 }
6679
6680 /**
6681 * Retrieve extended data from the intent.
6682 *
6683 * @param name The name of the desired item.
6684 *
6685 * @return the value of an item that previously added with putExtra()
6686 * or null if no long array value was found.
6687 *
6688 * @see #putExtra(String, long[])
6689 */
6690 public long[] getLongArrayExtra(String name) {
6691 return mExtras == null ? null : mExtras.getLongArray(name);
6692 }
6693
6694 /**
6695 * Retrieve extended data from the intent.
6696 *
6697 * @param name The name of the desired item.
6698 *
6699 * @return the value of an item that previously added with putExtra()
6700 * or null if no float array value was found.
6701 *
6702 * @see #putExtra(String, float[])
6703 */
6704 public float[] getFloatArrayExtra(String name) {
6705 return mExtras == null ? null : mExtras.getFloatArray(name);
6706 }
6707
6708 /**
6709 * Retrieve extended data from the intent.
6710 *
6711 * @param name The name of the desired item.
6712 *
6713 * @return the value of an item that previously added with putExtra()
6714 * or null if no double array value was found.
6715 *
6716 * @see #putExtra(String, double[])
6717 */
6718 public double[] getDoubleArrayExtra(String name) {
6719 return mExtras == null ? null : mExtras.getDoubleArray(name);
6720 }
6721
6722 /**
6723 * Retrieve extended data from the intent.
6724 *
6725 * @param name The name of the desired item.
6726 *
6727 * @return the value of an item that previously added with putExtra()
6728 * or null if no String array value was found.
6729 *
6730 * @see #putExtra(String, String[])
6731 */
6732 public String[] getStringArrayExtra(String name) {
6733 return mExtras == null ? null : mExtras.getStringArray(name);
6734 }
6735
6736 /**
6737 * Retrieve extended data from the intent.
6738 *
6739 * @param name The name of the desired item.
6740 *
6741 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006742 * or null if no CharSequence array value was found.
6743 *
6744 * @see #putExtra(String, CharSequence[])
6745 */
6746 public CharSequence[] getCharSequenceArrayExtra(String name) {
6747 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6748 }
6749
6750 /**
6751 * Retrieve extended data from the intent.
6752 *
6753 * @param name The name of the desired item.
6754 *
6755 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006756 * or null if no Bundle value was found.
6757 *
6758 * @see #putExtra(String, Bundle)
6759 */
6760 public Bundle getBundleExtra(String name) {
6761 return mExtras == null ? null : mExtras.getBundle(name);
6762 }
6763
6764 /**
6765 * Retrieve extended data from the intent.
6766 *
6767 * @param name The name of the desired item.
6768 *
6769 * @return the value of an item that previously added with putExtra()
6770 * or null if no IBinder value was found.
6771 *
6772 * @see #putExtra(String, IBinder)
6773 *
6774 * @deprecated
6775 * @hide
6776 */
6777 @Deprecated
6778 public IBinder getIBinderExtra(String name) {
6779 return mExtras == null ? null : mExtras.getIBinder(name);
6780 }
6781
6782 /**
6783 * Retrieve extended data from the intent.
6784 *
6785 * @param name The name of the desired item.
6786 * @param defaultValue The default value to return in case no item is
6787 * associated with the key 'name'
6788 *
6789 * @return the value of an item that previously added with putExtra()
6790 * or defaultValue if none was found.
6791 *
6792 * @see #putExtra
6793 *
6794 * @deprecated
6795 * @hide
6796 */
6797 @Deprecated
6798 public Object getExtra(String name, Object defaultValue) {
6799 Object result = defaultValue;
6800 if (mExtras != null) {
6801 Object result2 = mExtras.get(name);
6802 if (result2 != null) {
6803 result = result2;
6804 }
6805 }
6806
6807 return result;
6808 }
6809
6810 /**
6811 * Retrieves a map of extended data from the intent.
6812 *
6813 * @return the map of all extras previously added with putExtra(),
6814 * or null if none have been added.
6815 */
6816 public Bundle getExtras() {
6817 return (mExtras != null)
6818 ? new Bundle(mExtras)
6819 : null;
6820 }
6821
6822 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006823 * Filter extras to only basic types.
6824 * @hide
6825 */
6826 public void removeUnsafeExtras() {
6827 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006828 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006829 }
6830 }
6831
6832 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006833 * Retrieve any special flags associated with this intent. You will
6834 * normally just set them with {@link #setFlags} and let the system
6835 * take the appropriate action with them.
6836 *
6837 * @return int The currently set flags.
6838 *
6839 * @see #setFlags
6840 */
6841 public int getFlags() {
6842 return mFlags;
6843 }
6844
Dianne Hackborne7f97212011-02-24 14:40:20 -08006845 /** @hide */
6846 public boolean isExcludingStopped() {
6847 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6848 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6849 }
6850
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006851 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006852 * Retrieve the application package name this Intent is limited to. When
6853 * resolving an Intent, if non-null this limits the resolution to only
6854 * components in the given application package.
6855 *
6856 * @return The name of the application package for the Intent.
6857 *
6858 * @see #resolveActivity
6859 * @see #setPackage
6860 */
6861 public String getPackage() {
6862 return mPackage;
6863 }
6864
6865 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006866 * Retrieve the concrete component associated with the intent. When receiving
6867 * an intent, this is the component that was found to best handle it (that is,
6868 * yourself) and will always be non-null; in all other cases it will be
6869 * null unless explicitly set.
6870 *
6871 * @return The name of the application component to handle the intent.
6872 *
6873 * @see #resolveActivity
6874 * @see #setComponent
6875 */
6876 public ComponentName getComponent() {
6877 return mComponent;
6878 }
6879
6880 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006881 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6882 * used as a hint to the receiver for animations and the like. Null means that there
6883 * is no source bounds.
6884 */
6885 public Rect getSourceBounds() {
6886 return mSourceBounds;
6887 }
6888
6889 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006890 * Return the Activity component that should be used to handle this intent.
6891 * The appropriate component is determined based on the information in the
6892 * intent, evaluated as follows:
6893 *
6894 * <p>If {@link #getComponent} returns an explicit class, that is returned
6895 * without any further consideration.
6896 *
6897 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6898 * category to be considered.
6899 *
6900 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6901 * action.
6902 *
6903 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6904 * this type.
6905 *
6906 * <p>If {@link #addCategory} has added any categories, the activity must
6907 * handle ALL of the categories specified.
6908 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006909 * <p>If {@link #getPackage} is non-NULL, only activity components in
6910 * that application package will be considered.
6911 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006912 * <p>If there are no activities that satisfy all of these conditions, a
6913 * null string is returned.
6914 *
6915 * <p>If multiple activities are found to satisfy the intent, the one with
6916 * the highest priority will be used. If there are multiple activities
6917 * with the same priority, the system will either pick the best activity
6918 * based on user preference, or resolve to a system class that will allow
6919 * the user to pick an activity and forward from there.
6920 *
6921 * <p>This method is implemented simply by calling
6922 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6923 * true.</p>
6924 * <p> This API is called for you as part of starting an activity from an
6925 * intent. You do not normally need to call it yourself.</p>
6926 *
6927 * @param pm The package manager with which to resolve the Intent.
6928 *
6929 * @return Name of the component implementing an activity that can
6930 * display the intent.
6931 *
6932 * @see #setComponent
6933 * @see #getComponent
6934 * @see #resolveActivityInfo
6935 */
6936 public ComponentName resolveActivity(PackageManager pm) {
6937 if (mComponent != null) {
6938 return mComponent;
6939 }
6940
6941 ResolveInfo info = pm.resolveActivity(
6942 this, PackageManager.MATCH_DEFAULT_ONLY);
6943 if (info != null) {
6944 return new ComponentName(
6945 info.activityInfo.applicationInfo.packageName,
6946 info.activityInfo.name);
6947 }
6948
6949 return null;
6950 }
6951
6952 /**
6953 * Resolve the Intent into an {@link ActivityInfo}
6954 * describing the activity that should execute the intent. Resolution
6955 * follows the same rules as described for {@link #resolveActivity}, but
6956 * you get back the completely information about the resolved activity
6957 * instead of just its class name.
6958 *
6959 * @param pm The package manager with which to resolve the Intent.
6960 * @param flags Addition information to retrieve as per
6961 * {@link PackageManager#getActivityInfo(ComponentName, int)
6962 * PackageManager.getActivityInfo()}.
6963 *
6964 * @return PackageManager.ActivityInfo
6965 *
6966 * @see #resolveActivity
6967 */
6968 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6969 ActivityInfo ai = null;
6970 if (mComponent != null) {
6971 try {
6972 ai = pm.getActivityInfo(mComponent, flags);
6973 } catch (PackageManager.NameNotFoundException e) {
6974 // ignore
6975 }
6976 } else {
6977 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006978 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006979 if (info != null) {
6980 ai = info.activityInfo;
6981 }
6982 }
6983
6984 return ai;
6985 }
6986
6987 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006988 * Special function for use by the system to resolve service
6989 * intents to system apps. Throws an exception if there are
6990 * multiple potential matches to the Intent. Returns null if
6991 * there are no matches.
6992 * @hide
6993 */
6994 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6995 if (mComponent != null) {
6996 return mComponent;
6997 }
6998
6999 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7000 if (results == null) {
7001 return null;
7002 }
7003 ComponentName comp = null;
7004 for (int i=0; i<results.size(); i++) {
7005 ResolveInfo ri = results.get(i);
7006 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7007 continue;
7008 }
7009 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7010 ri.serviceInfo.name);
7011 if (comp != null) {
7012 throw new IllegalStateException("Multiple system services handle " + this
7013 + ": " + comp + ", " + foundComp);
7014 }
7015 comp = foundComp;
7016 }
7017 return comp;
7018 }
7019
7020 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007021 * Set the general action to be performed.
7022 *
7023 * @param action An action name, such as ACTION_VIEW. Application-specific
7024 * actions should be prefixed with the vendor's package name.
7025 *
7026 * @return Returns the same Intent object, for chaining multiple calls
7027 * into a single statement.
7028 *
7029 * @see #getAction
7030 */
7031 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007032 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007033 return this;
7034 }
7035
7036 /**
7037 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007038 * clears any type that was previously set by {@link #setType} or
7039 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007040 *
Nick Pellyccae4122012-01-09 14:12:58 -08007041 * <p><em>Note: scheme matching in the Android framework is
7042 * case-sensitive, unlike the formal RFC. As a result,
7043 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007044 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007045 * {@link #setDataAndNormalize}
7046 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007047 *
Nick Pellyccae4122012-01-09 14:12:58 -08007048 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007049 *
7050 * @return Returns the same Intent object, for chaining multiple calls
7051 * into a single statement.
7052 *
7053 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007054 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007055 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007056 */
7057 public Intent setData(Uri data) {
7058 mData = data;
7059 mType = null;
7060 return this;
7061 }
7062
7063 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007064 * Normalize and set the data this intent is operating on.
7065 *
7066 * <p>This method automatically clears any type that was
7067 * previously set (for example, by {@link #setType}).
7068 *
7069 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007070 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007071 * so really this is just a convenience method for
7072 * <pre>
7073 * setData(data.normalize())
7074 * </pre>
7075 *
7076 * @param data The Uri of the data this intent is now targeting.
7077 *
7078 * @return Returns the same Intent object, for chaining multiple calls
7079 * into a single statement.
7080 *
7081 * @see #getData
7082 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007083 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007084 */
7085 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007086 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007087 }
7088
7089 /**
7090 * Set an explicit MIME data type.
7091 *
7092 * <p>This is used to create intents that only specify a type and not data,
7093 * for example to indicate the type of data to return.
7094 *
7095 * <p>This method automatically clears any data that was
7096 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007097 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007098 * <p><em>Note: MIME type matching in the Android framework is
7099 * case-sensitive, unlike formal RFC MIME types. As a result,
7100 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007101 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7102 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007103 *
7104 * @param type The MIME type of the data being handled by this intent.
7105 *
7106 * @return Returns the same Intent object, for chaining multiple calls
7107 * into a single statement.
7108 *
7109 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007110 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007111 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007112 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007113 */
7114 public Intent setType(String type) {
7115 mData = null;
7116 mType = type;
7117 return this;
7118 }
7119
7120 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007121 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007122 *
Nick Pellyccae4122012-01-09 14:12:58 -08007123 * <p>This is used to create intents that only specify a type and not data,
7124 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007125 *
Nick Pellyccae4122012-01-09 14:12:58 -08007126 * <p>This method automatically clears any data that was
7127 * previously set (for example by {@link #setData}).
7128 *
7129 * <p>The MIME type is normalized using
7130 * {@link #normalizeMimeType} before it is set,
7131 * so really this is just a convenience method for
7132 * <pre>
7133 * setType(Intent.normalizeMimeType(type))
7134 * </pre>
7135 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007136 * @param type The MIME type of the data being handled by this intent.
7137 *
7138 * @return Returns the same Intent object, for chaining multiple calls
7139 * into a single statement.
7140 *
Nick Pellyccae4122012-01-09 14:12:58 -08007141 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007142 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007143 * @see #normalizeMimeType
7144 */
7145 public Intent setTypeAndNormalize(String type) {
7146 return setType(normalizeMimeType(type));
7147 }
7148
7149 /**
7150 * (Usually optional) Set the data for the intent along with an explicit
7151 * MIME data type. This method should very rarely be used -- it allows you
7152 * to override the MIME type that would ordinarily be inferred from the
7153 * data with your own type given here.
7154 *
7155 * <p><em>Note: MIME type and Uri scheme matching in the
7156 * Android framework is case-sensitive, unlike the formal RFC definitions.
7157 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007158 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007159 * {@link #setDataAndTypeAndNormalize}
7160 * to ensure that they are converted to lower case.</em>
7161 *
7162 * @param data The Uri of the data this intent is now targeting.
7163 * @param type The MIME type of the data being handled by this intent.
7164 *
7165 * @return Returns the same Intent object, for chaining multiple calls
7166 * into a single statement.
7167 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007168 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007169 * @see #setData
7170 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007171 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007172 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007173 */
7174 public Intent setDataAndType(Uri data, String type) {
7175 mData = data;
7176 mType = type;
7177 return this;
7178 }
7179
7180 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007181 * (Usually optional) Normalize and set both the data Uri and an explicit
7182 * MIME data type. This method should very rarely be used -- it allows you
7183 * to override the MIME type that would ordinarily be inferred from the
7184 * data with your own type given here.
7185 *
7186 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007187 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007188 * before they are set, so really this is just a convenience method for
7189 * <pre>
7190 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7191 * </pre>
7192 *
7193 * @param data The Uri of the data this intent is now targeting.
7194 * @param type The MIME type of the data being handled by this intent.
7195 *
7196 * @return Returns the same Intent object, for chaining multiple calls
7197 * into a single statement.
7198 *
7199 * @see #setType
7200 * @see #setData
7201 * @see #setDataAndType
7202 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007203 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007204 */
7205 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007206 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007207 }
7208
7209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007210 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007211 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007212 * activities that provide <em>all</em> of the requested categories will be
7213 * used.
7214 *
7215 * @param category The desired category. This can be either one of the
7216 * predefined Intent categories, or a custom category in your own
7217 * namespace.
7218 *
7219 * @return Returns the same Intent object, for chaining multiple calls
7220 * into a single statement.
7221 *
7222 * @see #hasCategory
7223 * @see #removeCategory
7224 */
7225 public Intent addCategory(String category) {
7226 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007227 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007228 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007229 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007230 return this;
7231 }
7232
7233 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007234 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007235 *
7236 * @param category The category to remove.
7237 *
7238 * @see #addCategory
7239 */
7240 public void removeCategory(String category) {
7241 if (mCategories != null) {
7242 mCategories.remove(category);
7243 if (mCategories.size() == 0) {
7244 mCategories = null;
7245 }
7246 }
7247 }
7248
7249 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007250 * Set a selector for this Intent. This is a modification to the kinds of
7251 * things the Intent will match. If the selector is set, it will be used
7252 * when trying to find entities that can handle the Intent, instead of the
7253 * main contents of the Intent. This allows you build an Intent containing
7254 * a generic protocol while targeting it more specifically.
7255 *
7256 * <p>An example of where this may be used is with things like
7257 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7258 * Intent that will launch the Browser application. However, the correct
7259 * main entry point of an application is actually {@link #ACTION_MAIN}
7260 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7261 * used to specify the actual Activity to launch. If you launch the browser
7262 * with something different, undesired behavior may happen if the user has
7263 * previously or later launches it the normal way, since they do not match.
7264 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7265 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7266 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7267 *
7268 * <p>Setting a selector does not impact the behavior of
7269 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7270 * desired behavior of a selector -- it does not impact the base meaning
7271 * of the Intent, just what kinds of things will be matched against it
7272 * when determining who can handle it.</p>
7273 *
7274 * <p>You can not use both a selector and {@link #setPackage(String)} on
7275 * the same base Intent.</p>
7276 *
7277 * @param selector The desired selector Intent; set to null to not use
7278 * a special selector.
7279 */
7280 public void setSelector(Intent selector) {
7281 if (selector == this) {
7282 throw new IllegalArgumentException(
7283 "Intent being set as a selector of itself");
7284 }
7285 if (selector != null && mPackage != null) {
7286 throw new IllegalArgumentException(
7287 "Can't set selector when package name is already set");
7288 }
7289 mSelector = selector;
7290 }
7291
7292 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007293 * Set a {@link ClipData} associated with this Intent. This replaces any
7294 * previously set ClipData.
7295 *
7296 * <p>The ClipData in an intent is not used for Intent matching or other
7297 * such operations. Semantically it is like extras, used to transmit
7298 * additional data with the Intent. The main feature of using this over
7299 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7300 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7301 * items included in the clip data. This is useful, in particular, if
7302 * you want to transmit an Intent containing multiple <code>content:</code>
7303 * URIs for which the recipient may not have global permission to access the
7304 * content provider.
7305 *
7306 * <p>If the ClipData contains items that are themselves Intents, any
7307 * grant flags in those Intents will be ignored. Only the top-level flags
7308 * of the main Intent are respected, and will be applied to all Uri or
7309 * Intent items in the clip (or sub-items of the clip).
7310 *
7311 * <p>The MIME type, label, and icon in the ClipData object are not
7312 * directly used by Intent. Applications should generally rely on the
7313 * MIME type of the Intent itself, not what it may find in the ClipData.
7314 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007315 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007316 *
7317 * @param clip The new clip to set. May be null to clear the current clip.
7318 */
7319 public void setClipData(ClipData clip) {
7320 mClipData = clip;
7321 }
7322
7323 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007324 * This is NOT a secure mechanism to identify the user who sent the intent.
7325 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7326 * who sent the intent.
7327 * @hide
7328 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007329 public void prepareToLeaveUser(int userId) {
7330 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7331 // We want mContentUserHint to refer to the original user, so don't do anything.
7332 if (mContentUserHint == UserHandle.USER_CURRENT) {
7333 mContentUserHint = userId;
7334 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007335 }
7336
7337 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007338 * Add extended data to the intent. The name must include a package
7339 * prefix, for example the app com.android.contacts would use names
7340 * like "com.android.contacts.ShowAll".
7341 *
7342 * @param name The name of the extra data, with package prefix.
7343 * @param value The boolean data value.
7344 *
7345 * @return Returns the same Intent object, for chaining multiple calls
7346 * into a single statement.
7347 *
7348 * @see #putExtras
7349 * @see #removeExtra
7350 * @see #getBooleanExtra(String, boolean)
7351 */
7352 public Intent putExtra(String name, boolean value) {
7353 if (mExtras == null) {
7354 mExtras = new Bundle();
7355 }
7356 mExtras.putBoolean(name, value);
7357 return this;
7358 }
7359
7360 /**
7361 * Add extended data to the intent. The name must include a package
7362 * prefix, for example the app com.android.contacts would use names
7363 * like "com.android.contacts.ShowAll".
7364 *
7365 * @param name The name of the extra data, with package prefix.
7366 * @param value The byte data value.
7367 *
7368 * @return Returns the same Intent object, for chaining multiple calls
7369 * into a single statement.
7370 *
7371 * @see #putExtras
7372 * @see #removeExtra
7373 * @see #getByteExtra(String, byte)
7374 */
7375 public Intent putExtra(String name, byte value) {
7376 if (mExtras == null) {
7377 mExtras = new Bundle();
7378 }
7379 mExtras.putByte(name, value);
7380 return this;
7381 }
7382
7383 /**
7384 * Add extended data to the intent. The name must include a package
7385 * prefix, for example the app com.android.contacts would use names
7386 * like "com.android.contacts.ShowAll".
7387 *
7388 * @param name The name of the extra data, with package prefix.
7389 * @param value The char data value.
7390 *
7391 * @return Returns the same Intent object, for chaining multiple calls
7392 * into a single statement.
7393 *
7394 * @see #putExtras
7395 * @see #removeExtra
7396 * @see #getCharExtra(String, char)
7397 */
7398 public Intent putExtra(String name, char value) {
7399 if (mExtras == null) {
7400 mExtras = new Bundle();
7401 }
7402 mExtras.putChar(name, value);
7403 return this;
7404 }
7405
7406 /**
7407 * Add extended data to the intent. The name must include a package
7408 * prefix, for example the app com.android.contacts would use names
7409 * like "com.android.contacts.ShowAll".
7410 *
7411 * @param name The name of the extra data, with package prefix.
7412 * @param value The short data value.
7413 *
7414 * @return Returns the same Intent object, for chaining multiple calls
7415 * into a single statement.
7416 *
7417 * @see #putExtras
7418 * @see #removeExtra
7419 * @see #getShortExtra(String, short)
7420 */
7421 public Intent putExtra(String name, short value) {
7422 if (mExtras == null) {
7423 mExtras = new Bundle();
7424 }
7425 mExtras.putShort(name, value);
7426 return this;
7427 }
7428
7429 /**
7430 * Add extended data to the intent. The name must include a package
7431 * prefix, for example the app com.android.contacts would use names
7432 * like "com.android.contacts.ShowAll".
7433 *
7434 * @param name The name of the extra data, with package prefix.
7435 * @param value The integer data value.
7436 *
7437 * @return Returns the same Intent object, for chaining multiple calls
7438 * into a single statement.
7439 *
7440 * @see #putExtras
7441 * @see #removeExtra
7442 * @see #getIntExtra(String, int)
7443 */
7444 public Intent putExtra(String name, int value) {
7445 if (mExtras == null) {
7446 mExtras = new Bundle();
7447 }
7448 mExtras.putInt(name, value);
7449 return this;
7450 }
7451
7452 /**
7453 * Add extended data to the intent. The name must include a package
7454 * prefix, for example the app com.android.contacts would use names
7455 * like "com.android.contacts.ShowAll".
7456 *
7457 * @param name The name of the extra data, with package prefix.
7458 * @param value The long data value.
7459 *
7460 * @return Returns the same Intent object, for chaining multiple calls
7461 * into a single statement.
7462 *
7463 * @see #putExtras
7464 * @see #removeExtra
7465 * @see #getLongExtra(String, long)
7466 */
7467 public Intent putExtra(String name, long value) {
7468 if (mExtras == null) {
7469 mExtras = new Bundle();
7470 }
7471 mExtras.putLong(name, value);
7472 return this;
7473 }
7474
7475 /**
7476 * Add extended data to the intent. The name must include a package
7477 * prefix, for example the app com.android.contacts would use names
7478 * like "com.android.contacts.ShowAll".
7479 *
7480 * @param name The name of the extra data, with package prefix.
7481 * @param value The float data value.
7482 *
7483 * @return Returns the same Intent object, for chaining multiple calls
7484 * into a single statement.
7485 *
7486 * @see #putExtras
7487 * @see #removeExtra
7488 * @see #getFloatExtra(String, float)
7489 */
7490 public Intent putExtra(String name, float value) {
7491 if (mExtras == null) {
7492 mExtras = new Bundle();
7493 }
7494 mExtras.putFloat(name, value);
7495 return this;
7496 }
7497
7498 /**
7499 * Add extended data to the intent. The name must include a package
7500 * prefix, for example the app com.android.contacts would use names
7501 * like "com.android.contacts.ShowAll".
7502 *
7503 * @param name The name of the extra data, with package prefix.
7504 * @param value The double data value.
7505 *
7506 * @return Returns the same Intent object, for chaining multiple calls
7507 * into a single statement.
7508 *
7509 * @see #putExtras
7510 * @see #removeExtra
7511 * @see #getDoubleExtra(String, double)
7512 */
7513 public Intent putExtra(String name, double value) {
7514 if (mExtras == null) {
7515 mExtras = new Bundle();
7516 }
7517 mExtras.putDouble(name, value);
7518 return this;
7519 }
7520
7521 /**
7522 * Add extended data to the intent. The name must include a package
7523 * prefix, for example the app com.android.contacts would use names
7524 * like "com.android.contacts.ShowAll".
7525 *
7526 * @param name The name of the extra data, with package prefix.
7527 * @param value The String data value.
7528 *
7529 * @return Returns the same Intent object, for chaining multiple calls
7530 * into a single statement.
7531 *
7532 * @see #putExtras
7533 * @see #removeExtra
7534 * @see #getStringExtra(String)
7535 */
7536 public Intent putExtra(String name, String value) {
7537 if (mExtras == null) {
7538 mExtras = new Bundle();
7539 }
7540 mExtras.putString(name, value);
7541 return this;
7542 }
7543
7544 /**
7545 * Add extended data to the intent. The name must include a package
7546 * prefix, for example the app com.android.contacts would use names
7547 * like "com.android.contacts.ShowAll".
7548 *
7549 * @param name The name of the extra data, with package prefix.
7550 * @param value The CharSequence data value.
7551 *
7552 * @return Returns the same Intent object, for chaining multiple calls
7553 * into a single statement.
7554 *
7555 * @see #putExtras
7556 * @see #removeExtra
7557 * @see #getCharSequenceExtra(String)
7558 */
7559 public Intent putExtra(String name, CharSequence value) {
7560 if (mExtras == null) {
7561 mExtras = new Bundle();
7562 }
7563 mExtras.putCharSequence(name, value);
7564 return this;
7565 }
7566
7567 /**
7568 * Add extended data to the intent. The name must include a package
7569 * prefix, for example the app com.android.contacts would use names
7570 * like "com.android.contacts.ShowAll".
7571 *
7572 * @param name The name of the extra data, with package prefix.
7573 * @param value The Parcelable data value.
7574 *
7575 * @return Returns the same Intent object, for chaining multiple calls
7576 * into a single statement.
7577 *
7578 * @see #putExtras
7579 * @see #removeExtra
7580 * @see #getParcelableExtra(String)
7581 */
7582 public Intent putExtra(String name, Parcelable value) {
7583 if (mExtras == null) {
7584 mExtras = new Bundle();
7585 }
7586 mExtras.putParcelable(name, value);
7587 return this;
7588 }
7589
7590 /**
7591 * Add extended data to the intent. The name must include a package
7592 * prefix, for example the app com.android.contacts would use names
7593 * like "com.android.contacts.ShowAll".
7594 *
7595 * @param name The name of the extra data, with package prefix.
7596 * @param value The Parcelable[] data value.
7597 *
7598 * @return Returns the same Intent object, for chaining multiple calls
7599 * into a single statement.
7600 *
7601 * @see #putExtras
7602 * @see #removeExtra
7603 * @see #getParcelableArrayExtra(String)
7604 */
7605 public Intent putExtra(String name, Parcelable[] value) {
7606 if (mExtras == null) {
7607 mExtras = new Bundle();
7608 }
7609 mExtras.putParcelableArray(name, value);
7610 return this;
7611 }
7612
7613 /**
7614 * Add extended data to the intent. The name must include a package
7615 * prefix, for example the app com.android.contacts would use names
7616 * like "com.android.contacts.ShowAll".
7617 *
7618 * @param name The name of the extra data, with package prefix.
7619 * @param value The ArrayList<Parcelable> data value.
7620 *
7621 * @return Returns the same Intent object, for chaining multiple calls
7622 * into a single statement.
7623 *
7624 * @see #putExtras
7625 * @see #removeExtra
7626 * @see #getParcelableArrayListExtra(String)
7627 */
7628 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7629 if (mExtras == null) {
7630 mExtras = new Bundle();
7631 }
7632 mExtras.putParcelableArrayList(name, value);
7633 return this;
7634 }
7635
7636 /**
7637 * Add extended data to the intent. The name must include a package
7638 * prefix, for example the app com.android.contacts would use names
7639 * like "com.android.contacts.ShowAll".
7640 *
7641 * @param name The name of the extra data, with package prefix.
7642 * @param value The ArrayList<Integer> data value.
7643 *
7644 * @return Returns the same Intent object, for chaining multiple calls
7645 * into a single statement.
7646 *
7647 * @see #putExtras
7648 * @see #removeExtra
7649 * @see #getIntegerArrayListExtra(String)
7650 */
7651 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7652 if (mExtras == null) {
7653 mExtras = new Bundle();
7654 }
7655 mExtras.putIntegerArrayList(name, value);
7656 return this;
7657 }
7658
7659 /**
7660 * Add extended data to the intent. The name must include a package
7661 * prefix, for example the app com.android.contacts would use names
7662 * like "com.android.contacts.ShowAll".
7663 *
7664 * @param name The name of the extra data, with package prefix.
7665 * @param value The ArrayList<String> data value.
7666 *
7667 * @return Returns the same Intent object, for chaining multiple calls
7668 * into a single statement.
7669 *
7670 * @see #putExtras
7671 * @see #removeExtra
7672 * @see #getStringArrayListExtra(String)
7673 */
7674 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7675 if (mExtras == null) {
7676 mExtras = new Bundle();
7677 }
7678 mExtras.putStringArrayList(name, value);
7679 return this;
7680 }
7681
7682 /**
7683 * Add extended data to the intent. The name must include a package
7684 * prefix, for example the app com.android.contacts would use names
7685 * like "com.android.contacts.ShowAll".
7686 *
7687 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007688 * @param value The ArrayList<CharSequence> data value.
7689 *
7690 * @return Returns the same Intent object, for chaining multiple calls
7691 * into a single statement.
7692 *
7693 * @see #putExtras
7694 * @see #removeExtra
7695 * @see #getCharSequenceArrayListExtra(String)
7696 */
7697 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7698 if (mExtras == null) {
7699 mExtras = new Bundle();
7700 }
7701 mExtras.putCharSequenceArrayList(name, value);
7702 return this;
7703 }
7704
7705 /**
7706 * Add extended data to the intent. The name must include a package
7707 * prefix, for example the app com.android.contacts would use names
7708 * like "com.android.contacts.ShowAll".
7709 *
7710 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007711 * @param value The Serializable data value.
7712 *
7713 * @return Returns the same Intent object, for chaining multiple calls
7714 * into a single statement.
7715 *
7716 * @see #putExtras
7717 * @see #removeExtra
7718 * @see #getSerializableExtra(String)
7719 */
7720 public Intent putExtra(String name, Serializable value) {
7721 if (mExtras == null) {
7722 mExtras = new Bundle();
7723 }
7724 mExtras.putSerializable(name, value);
7725 return this;
7726 }
7727
7728 /**
7729 * Add extended data to the intent. The name must include a package
7730 * prefix, for example the app com.android.contacts would use names
7731 * like "com.android.contacts.ShowAll".
7732 *
7733 * @param name The name of the extra data, with package prefix.
7734 * @param value The boolean array data value.
7735 *
7736 * @return Returns the same Intent object, for chaining multiple calls
7737 * into a single statement.
7738 *
7739 * @see #putExtras
7740 * @see #removeExtra
7741 * @see #getBooleanArrayExtra(String)
7742 */
7743 public Intent putExtra(String name, boolean[] value) {
7744 if (mExtras == null) {
7745 mExtras = new Bundle();
7746 }
7747 mExtras.putBooleanArray(name, value);
7748 return this;
7749 }
7750
7751 /**
7752 * Add extended data to the intent. The name must include a package
7753 * prefix, for example the app com.android.contacts would use names
7754 * like "com.android.contacts.ShowAll".
7755 *
7756 * @param name The name of the extra data, with package prefix.
7757 * @param value The byte array data value.
7758 *
7759 * @return Returns the same Intent object, for chaining multiple calls
7760 * into a single statement.
7761 *
7762 * @see #putExtras
7763 * @see #removeExtra
7764 * @see #getByteArrayExtra(String)
7765 */
7766 public Intent putExtra(String name, byte[] value) {
7767 if (mExtras == null) {
7768 mExtras = new Bundle();
7769 }
7770 mExtras.putByteArray(name, value);
7771 return this;
7772 }
7773
7774 /**
7775 * Add extended data to the intent. The name must include a package
7776 * prefix, for example the app com.android.contacts would use names
7777 * like "com.android.contacts.ShowAll".
7778 *
7779 * @param name The name of the extra data, with package prefix.
7780 * @param value The short array data value.
7781 *
7782 * @return Returns the same Intent object, for chaining multiple calls
7783 * into a single statement.
7784 *
7785 * @see #putExtras
7786 * @see #removeExtra
7787 * @see #getShortArrayExtra(String)
7788 */
7789 public Intent putExtra(String name, short[] value) {
7790 if (mExtras == null) {
7791 mExtras = new Bundle();
7792 }
7793 mExtras.putShortArray(name, value);
7794 return this;
7795 }
7796
7797 /**
7798 * Add extended data to the intent. The name must include a package
7799 * prefix, for example the app com.android.contacts would use names
7800 * like "com.android.contacts.ShowAll".
7801 *
7802 * @param name The name of the extra data, with package prefix.
7803 * @param value The char array data value.
7804 *
7805 * @return Returns the same Intent object, for chaining multiple calls
7806 * into a single statement.
7807 *
7808 * @see #putExtras
7809 * @see #removeExtra
7810 * @see #getCharArrayExtra(String)
7811 */
7812 public Intent putExtra(String name, char[] value) {
7813 if (mExtras == null) {
7814 mExtras = new Bundle();
7815 }
7816 mExtras.putCharArray(name, value);
7817 return this;
7818 }
7819
7820 /**
7821 * Add extended data to the intent. The name must include a package
7822 * prefix, for example the app com.android.contacts would use names
7823 * like "com.android.contacts.ShowAll".
7824 *
7825 * @param name The name of the extra data, with package prefix.
7826 * @param value The int array data value.
7827 *
7828 * @return Returns the same Intent object, for chaining multiple calls
7829 * into a single statement.
7830 *
7831 * @see #putExtras
7832 * @see #removeExtra
7833 * @see #getIntArrayExtra(String)
7834 */
7835 public Intent putExtra(String name, int[] value) {
7836 if (mExtras == null) {
7837 mExtras = new Bundle();
7838 }
7839 mExtras.putIntArray(name, value);
7840 return this;
7841 }
7842
7843 /**
7844 * Add extended data to the intent. The name must include a package
7845 * prefix, for example the app com.android.contacts would use names
7846 * like "com.android.contacts.ShowAll".
7847 *
7848 * @param name The name of the extra data, with package prefix.
7849 * @param value The byte array data value.
7850 *
7851 * @return Returns the same Intent object, for chaining multiple calls
7852 * into a single statement.
7853 *
7854 * @see #putExtras
7855 * @see #removeExtra
7856 * @see #getLongArrayExtra(String)
7857 */
7858 public Intent putExtra(String name, long[] value) {
7859 if (mExtras == null) {
7860 mExtras = new Bundle();
7861 }
7862 mExtras.putLongArray(name, value);
7863 return this;
7864 }
7865
7866 /**
7867 * Add extended data to the intent. The name must include a package
7868 * prefix, for example the app com.android.contacts would use names
7869 * like "com.android.contacts.ShowAll".
7870 *
7871 * @param name The name of the extra data, with package prefix.
7872 * @param value The float array data value.
7873 *
7874 * @return Returns the same Intent object, for chaining multiple calls
7875 * into a single statement.
7876 *
7877 * @see #putExtras
7878 * @see #removeExtra
7879 * @see #getFloatArrayExtra(String)
7880 */
7881 public Intent putExtra(String name, float[] value) {
7882 if (mExtras == null) {
7883 mExtras = new Bundle();
7884 }
7885 mExtras.putFloatArray(name, value);
7886 return this;
7887 }
7888
7889 /**
7890 * Add extended data to the intent. The name must include a package
7891 * prefix, for example the app com.android.contacts would use names
7892 * like "com.android.contacts.ShowAll".
7893 *
7894 * @param name The name of the extra data, with package prefix.
7895 * @param value The double array data value.
7896 *
7897 * @return Returns the same Intent object, for chaining multiple calls
7898 * into a single statement.
7899 *
7900 * @see #putExtras
7901 * @see #removeExtra
7902 * @see #getDoubleArrayExtra(String)
7903 */
7904 public Intent putExtra(String name, double[] value) {
7905 if (mExtras == null) {
7906 mExtras = new Bundle();
7907 }
7908 mExtras.putDoubleArray(name, value);
7909 return this;
7910 }
7911
7912 /**
7913 * Add extended data to the intent. The name must include a package
7914 * prefix, for example the app com.android.contacts would use names
7915 * like "com.android.contacts.ShowAll".
7916 *
7917 * @param name The name of the extra data, with package prefix.
7918 * @param value The String array data value.
7919 *
7920 * @return Returns the same Intent object, for chaining multiple calls
7921 * into a single statement.
7922 *
7923 * @see #putExtras
7924 * @see #removeExtra
7925 * @see #getStringArrayExtra(String)
7926 */
7927 public Intent putExtra(String name, String[] value) {
7928 if (mExtras == null) {
7929 mExtras = new Bundle();
7930 }
7931 mExtras.putStringArray(name, value);
7932 return this;
7933 }
7934
7935 /**
7936 * Add extended data to the intent. The name must include a package
7937 * prefix, for example the app com.android.contacts would use names
7938 * like "com.android.contacts.ShowAll".
7939 *
7940 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007941 * @param value The CharSequence array data value.
7942 *
7943 * @return Returns the same Intent object, for chaining multiple calls
7944 * into a single statement.
7945 *
7946 * @see #putExtras
7947 * @see #removeExtra
7948 * @see #getCharSequenceArrayExtra(String)
7949 */
7950 public Intent putExtra(String name, CharSequence[] value) {
7951 if (mExtras == null) {
7952 mExtras = new Bundle();
7953 }
7954 mExtras.putCharSequenceArray(name, value);
7955 return this;
7956 }
7957
7958 /**
7959 * Add extended data to the intent. The name must include a package
7960 * prefix, for example the app com.android.contacts would use names
7961 * like "com.android.contacts.ShowAll".
7962 *
7963 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007964 * @param value The Bundle data value.
7965 *
7966 * @return Returns the same Intent object, for chaining multiple calls
7967 * into a single statement.
7968 *
7969 * @see #putExtras
7970 * @see #removeExtra
7971 * @see #getBundleExtra(String)
7972 */
7973 public Intent putExtra(String name, Bundle value) {
7974 if (mExtras == null) {
7975 mExtras = new Bundle();
7976 }
7977 mExtras.putBundle(name, value);
7978 return this;
7979 }
7980
7981 /**
7982 * Add extended data to the intent. The name must include a package
7983 * prefix, for example the app com.android.contacts would use names
7984 * like "com.android.contacts.ShowAll".
7985 *
7986 * @param name The name of the extra data, with package prefix.
7987 * @param value The IBinder data value.
7988 *
7989 * @return Returns the same Intent object, for chaining multiple calls
7990 * into a single statement.
7991 *
7992 * @see #putExtras
7993 * @see #removeExtra
7994 * @see #getIBinderExtra(String)
7995 *
7996 * @deprecated
7997 * @hide
7998 */
7999 @Deprecated
8000 public Intent putExtra(String name, IBinder value) {
8001 if (mExtras == null) {
8002 mExtras = new Bundle();
8003 }
8004 mExtras.putIBinder(name, value);
8005 return this;
8006 }
8007
8008 /**
8009 * Copy all extras in 'src' in to this intent.
8010 *
8011 * @param src Contains the extras to copy.
8012 *
8013 * @see #putExtra
8014 */
8015 public Intent putExtras(Intent src) {
8016 if (src.mExtras != null) {
8017 if (mExtras == null) {
8018 mExtras = new Bundle(src.mExtras);
8019 } else {
8020 mExtras.putAll(src.mExtras);
8021 }
8022 }
8023 return this;
8024 }
8025
8026 /**
8027 * Add a set of extended data to the intent. The keys must include a package
8028 * prefix, for example the app com.android.contacts would use names
8029 * like "com.android.contacts.ShowAll".
8030 *
8031 * @param extras The Bundle of extras to add to this intent.
8032 *
8033 * @see #putExtra
8034 * @see #removeExtra
8035 */
8036 public Intent putExtras(Bundle extras) {
8037 if (mExtras == null) {
8038 mExtras = new Bundle();
8039 }
8040 mExtras.putAll(extras);
8041 return this;
8042 }
8043
8044 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008045 * Completely replace the extras in the Intent with the extras in the
8046 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008047 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008048 * @param src The exact extras contained in this Intent are copied
8049 * into the target intent, replacing any that were previously there.
8050 */
8051 public Intent replaceExtras(Intent src) {
8052 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8053 return this;
8054 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008055
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008056 /**
8057 * Completely replace the extras in the Intent with the given Bundle of
8058 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008059 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008060 * @param extras The new set of extras in the Intent, or null to erase
8061 * all extras.
8062 */
8063 public Intent replaceExtras(Bundle extras) {
8064 mExtras = extras != null ? new Bundle(extras) : null;
8065 return this;
8066 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008067
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008068 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008069 * Remove extended data from the intent.
8070 *
8071 * @see #putExtra
8072 */
8073 public void removeExtra(String name) {
8074 if (mExtras != null) {
8075 mExtras.remove(name);
8076 if (mExtras.size() == 0) {
8077 mExtras = null;
8078 }
8079 }
8080 }
8081
8082 /**
8083 * Set special flags controlling how this intent is handled. Most values
8084 * here depend on the type of component being executed by the Intent,
8085 * specifically the FLAG_ACTIVITY_* flags are all for use with
8086 * {@link Context#startActivity Context.startActivity()} and the
8087 * FLAG_RECEIVER_* flags are all for use with
8088 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8089 *
Scott Main7aee61f2011-02-08 11:25:01 -08008090 * <p>See the
8091 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8092 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008093 * the behavior of your application.
8094 *
8095 * @param flags The desired flags.
8096 *
8097 * @return Returns the same Intent object, for chaining multiple calls
8098 * into a single statement.
8099 *
8100 * @see #getFlags
8101 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008102 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008103 *
8104 * @see #FLAG_GRANT_READ_URI_PERMISSION
8105 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07008106 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
8107 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008108 * @see #FLAG_DEBUG_LOG_RESOLUTION
8109 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008111 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008112 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008113 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008114 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
8115 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008116 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008117 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07008118 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008119 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008120 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008121 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08008122 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008123 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
8124 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008125 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008126 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008127 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008128 * @see #FLAG_RECEIVER_REGISTERED_ONLY
8129 */
8130 public Intent setFlags(int flags) {
8131 mFlags = flags;
8132 return this;
8133 }
8134
8135 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008136 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008137 *
8138 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008139 * @return Returns the same Intent object, for chaining multiple calls into
8140 * a single statement.
8141 * @see #setFlags(int)
8142 * @see #removeFlags(int)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008143 */
8144 public Intent addFlags(int flags) {
8145 mFlags |= flags;
8146 return this;
8147 }
8148
8149 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008150 * Remove these flags from the intent.
8151 *
8152 * @param flags The flags to remove.
8153 * @see #setFlags(int)
8154 * @see #addFlags(int)
8155 */
8156 public void removeFlags(int flags) {
8157 mFlags &= ~flags;
8158 }
8159
8160 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008161 * (Usually optional) Set an explicit application package name that limits
8162 * the components this Intent will resolve to. If left to the default
8163 * value of null, all components in all applications will considered.
8164 * If non-null, the Intent can only match the components in the given
8165 * application package.
8166 *
8167 * @param packageName The name of the application package to handle the
8168 * intent, or null to allow any application package.
8169 *
8170 * @return Returns the same Intent object, for chaining multiple calls
8171 * into a single statement.
8172 *
8173 * @see #getPackage
8174 * @see #resolveActivity
8175 */
8176 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008177 if (packageName != null && mSelector != null) {
8178 throw new IllegalArgumentException(
8179 "Can't set package name when selector is already set");
8180 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008181 mPackage = packageName;
8182 return this;
8183 }
8184
8185 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008186 * (Usually optional) Explicitly set the component to handle the intent.
8187 * If left with the default value of null, the system will determine the
8188 * appropriate class to use based on the other fields (action, data,
8189 * type, categories) in the Intent. If this class is defined, the
8190 * specified class will always be used regardless of the other fields. You
8191 * should only set this value when you know you absolutely want a specific
8192 * class to be used; otherwise it is better to let the system find the
8193 * appropriate class so that you will respect the installed applications
8194 * and user preferences.
8195 *
8196 * @param component The name of the application component to handle the
8197 * intent, or null to let the system find one for you.
8198 *
8199 * @return Returns the same Intent object, for chaining multiple calls
8200 * into a single statement.
8201 *
8202 * @see #setClass
8203 * @see #setClassName(Context, String)
8204 * @see #setClassName(String, String)
8205 * @see #getComponent
8206 * @see #resolveActivity
8207 */
8208 public Intent setComponent(ComponentName component) {
8209 mComponent = component;
8210 return this;
8211 }
8212
8213 /**
8214 * Convenience for calling {@link #setComponent} with an
8215 * explicit class name.
8216 *
8217 * @param packageContext A Context of the application package implementing
8218 * this class.
8219 * @param className The name of a class inside of the application package
8220 * that will be used as the component for this Intent.
8221 *
8222 * @return Returns the same Intent object, for chaining multiple calls
8223 * into a single statement.
8224 *
8225 * @see #setComponent
8226 * @see #setClass
8227 */
8228 public Intent setClassName(Context packageContext, String className) {
8229 mComponent = new ComponentName(packageContext, className);
8230 return this;
8231 }
8232
8233 /**
8234 * Convenience for calling {@link #setComponent} with an
8235 * explicit application package name and class name.
8236 *
8237 * @param packageName The name of the package implementing the desired
8238 * component.
8239 * @param className The name of a class inside of the application package
8240 * that will be used as the component for this Intent.
8241 *
8242 * @return Returns the same Intent object, for chaining multiple calls
8243 * into a single statement.
8244 *
8245 * @see #setComponent
8246 * @see #setClass
8247 */
8248 public Intent setClassName(String packageName, String className) {
8249 mComponent = new ComponentName(packageName, className);
8250 return this;
8251 }
8252
8253 /**
8254 * Convenience for calling {@link #setComponent(ComponentName)} with the
8255 * name returned by a {@link Class} object.
8256 *
8257 * @param packageContext A Context of the application package implementing
8258 * this class.
8259 * @param cls The class name to set, equivalent to
8260 * <code>setClassName(context, cls.getName())</code>.
8261 *
8262 * @return Returns the same Intent object, for chaining multiple calls
8263 * into a single statement.
8264 *
8265 * @see #setComponent
8266 */
8267 public Intent setClass(Context packageContext, Class<?> cls) {
8268 mComponent = new ComponentName(packageContext, cls);
8269 return this;
8270 }
8271
8272 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008273 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8274 * used as a hint to the receiver for animations and the like. Null means that there
8275 * is no source bounds.
8276 */
8277 public void setSourceBounds(Rect r) {
8278 if (r != null) {
8279 mSourceBounds = new Rect(r);
8280 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008281 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008282 }
8283 }
8284
Tor Norbyed9273d62013-05-30 15:59:53 -07008285 /** @hide */
8286 @IntDef(flag = true,
8287 value = {
8288 FILL_IN_ACTION,
8289 FILL_IN_DATA,
8290 FILL_IN_CATEGORIES,
8291 FILL_IN_COMPONENT,
8292 FILL_IN_PACKAGE,
8293 FILL_IN_SOURCE_BOUNDS,
8294 FILL_IN_SELECTOR,
8295 FILL_IN_CLIP_DATA
8296 })
8297 @Retention(RetentionPolicy.SOURCE)
8298 public @interface FillInFlags {}
8299
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008300 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008301 * Use with {@link #fillIn} to allow the current action value to be
8302 * overwritten, even if it is already set.
8303 */
8304 public static final int FILL_IN_ACTION = 1<<0;
8305
8306 /**
8307 * Use with {@link #fillIn} to allow the current data or type value
8308 * overwritten, even if it is already set.
8309 */
8310 public static final int FILL_IN_DATA = 1<<1;
8311
8312 /**
8313 * Use with {@link #fillIn} to allow the current categories to be
8314 * overwritten, even if they are already set.
8315 */
8316 public static final int FILL_IN_CATEGORIES = 1<<2;
8317
8318 /**
8319 * Use with {@link #fillIn} to allow the current component value to be
8320 * overwritten, even if it is already set.
8321 */
8322 public static final int FILL_IN_COMPONENT = 1<<3;
8323
8324 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008325 * Use with {@link #fillIn} to allow the current package value to be
8326 * overwritten, even if it is already set.
8327 */
8328 public static final int FILL_IN_PACKAGE = 1<<4;
8329
8330 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008331 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008332 * overwritten, even if it is already set.
8333 */
8334 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8335
8336 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008337 * Use with {@link #fillIn} to allow the current selector to be
8338 * overwritten, even if it is already set.
8339 */
8340 public static final int FILL_IN_SELECTOR = 1<<6;
8341
8342 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008343 * Use with {@link #fillIn} to allow the current ClipData to be
8344 * overwritten, even if it is already set.
8345 */
8346 public static final int FILL_IN_CLIP_DATA = 1<<7;
8347
8348 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008349 * Copy the contents of <var>other</var> in to this object, but only
8350 * where fields are not defined by this object. For purposes of a field
8351 * being defined, the following pieces of data in the Intent are
8352 * considered to be separate fields:
8353 *
8354 * <ul>
8355 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008356 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008357 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8358 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008359 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008360 * <li> component, as set by {@link #setComponent(ComponentName)} or
8361 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008362 * <li> source bounds, as set by {@link #setSourceBounds}.
8363 * <li> selector, as set by {@link #setSelector(Intent)}.
8364 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008365 * <li> each top-level name in the associated extras.
8366 * </ul>
8367 *
8368 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008369 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008370 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8371 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8372 * the restriction where the corresponding field will not be replaced if
8373 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008374 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008375 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8376 * is explicitly specified. The selector will only be copied if
8377 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008378 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008379 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8380 * and Intent B with {action="gotit", data-type="some/thing",
8381 * categories="one","two"}.
8382 *
8383 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8384 * containing: {action="gotit", data-type="some/thing",
8385 * categories="bar"}.
8386 *
8387 * @param other Another Intent whose values are to be used to fill in
8388 * the current one.
8389 * @param flags Options to control which fields can be filled in.
8390 *
8391 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008392 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008393 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008394 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008395 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008396 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008397 @FillInFlags
8398 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008399 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008400 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008401 if (other.mAction != null
8402 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008403 mAction = other.mAction;
8404 changes |= FILL_IN_ACTION;
8405 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008406 if ((other.mData != null || other.mType != null)
8407 && ((mData == null && mType == null)
8408 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008409 mData = other.mData;
8410 mType = other.mType;
8411 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008412 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008413 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008414 if (other.mCategories != null
8415 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008416 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008417 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008418 }
8419 changes |= FILL_IN_CATEGORIES;
8420 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008421 if (other.mPackage != null
8422 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008423 // Only do this if mSelector is not set.
8424 if (mSelector == null) {
8425 mPackage = other.mPackage;
8426 changes |= FILL_IN_PACKAGE;
8427 }
8428 }
8429 // Selector is special: it can only be set if explicitly allowed,
8430 // for the same reason as the component name.
8431 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8432 if (mPackage == null) {
8433 mSelector = new Intent(other.mSelector);
8434 mPackage = null;
8435 changes |= FILL_IN_SELECTOR;
8436 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008437 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008438 if (other.mClipData != null
8439 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8440 mClipData = other.mClipData;
8441 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008442 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008443 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008444 // Component is special: it can -only- be set if explicitly allowed,
8445 // since otherwise the sender could force the intent somewhere the
8446 // originator didn't intend.
8447 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008448 mComponent = other.mComponent;
8449 changes |= FILL_IN_COMPONENT;
8450 }
8451 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008452 if (other.mSourceBounds != null
8453 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8454 mSourceBounds = new Rect(other.mSourceBounds);
8455 changes |= FILL_IN_SOURCE_BOUNDS;
8456 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008457 if (mExtras == null) {
8458 if (other.mExtras != null) {
8459 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008460 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008461 }
8462 } else if (other.mExtras != null) {
8463 try {
8464 Bundle newb = new Bundle(other.mExtras);
8465 newb.putAll(mExtras);
8466 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008467 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008468 } catch (RuntimeException e) {
8469 // Modifying the extras can cause us to unparcel the contents
8470 // of the bundle, and if we do this in the system process that
8471 // may fail. We really should handle this (i.e., the Bundle
8472 // impl shouldn't be on top of a plain map), but for now just
8473 // ignore it and keep the original contents. :(
8474 Log.w("Intent", "Failure filling in extras", e);
8475 }
8476 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008477 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8478 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8479 mContentUserHint = other.mContentUserHint;
8480 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008481 return changes;
8482 }
8483
8484 /**
8485 * Wrapper class holding an Intent and implementing comparisons on it for
8486 * the purpose of filtering. The class implements its
8487 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8488 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8489 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8490 * on the wrapped Intent.
8491 */
8492 public static final class FilterComparison {
8493 private final Intent mIntent;
8494 private final int mHashCode;
8495
8496 public FilterComparison(Intent intent) {
8497 mIntent = intent;
8498 mHashCode = intent.filterHashCode();
8499 }
8500
8501 /**
8502 * Return the Intent that this FilterComparison represents.
8503 * @return Returns the Intent held by the FilterComparison. Do
8504 * not modify!
8505 */
8506 public Intent getIntent() {
8507 return mIntent;
8508 }
8509
8510 @Override
8511 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008512 if (obj instanceof FilterComparison) {
8513 Intent other = ((FilterComparison)obj).mIntent;
8514 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008515 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008516 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008517 }
8518
8519 @Override
8520 public int hashCode() {
8521 return mHashCode;
8522 }
8523 }
8524
8525 /**
8526 * Determine if two intents are the same for the purposes of intent
8527 * resolution (filtering). That is, if their action, data, type,
8528 * class, and categories are the same. This does <em>not</em> compare
8529 * any extra data included in the intents.
8530 *
8531 * @param other The other Intent to compare against.
8532 *
8533 * @return Returns true if action, data, type, class, and categories
8534 * are the same.
8535 */
8536 public boolean filterEquals(Intent other) {
8537 if (other == null) {
8538 return false;
8539 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008540 if (!Objects.equals(this.mAction, other.mAction)) return false;
8541 if (!Objects.equals(this.mData, other.mData)) return false;
8542 if (!Objects.equals(this.mType, other.mType)) return false;
8543 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8544 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8545 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008546
8547 return true;
8548 }
8549
8550 /**
8551 * Generate hash code that matches semantics of filterEquals().
8552 *
8553 * @return Returns the hash value of the action, data, type, class, and
8554 * categories.
8555 *
8556 * @see #filterEquals
8557 */
8558 public int filterHashCode() {
8559 int code = 0;
8560 if (mAction != null) {
8561 code += mAction.hashCode();
8562 }
8563 if (mData != null) {
8564 code += mData.hashCode();
8565 }
8566 if (mType != null) {
8567 code += mType.hashCode();
8568 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008569 if (mPackage != null) {
8570 code += mPackage.hashCode();
8571 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008572 if (mComponent != null) {
8573 code += mComponent.hashCode();
8574 }
8575 if (mCategories != null) {
8576 code += mCategories.hashCode();
8577 }
8578 return code;
8579 }
8580
8581 @Override
8582 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008583 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008584
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008585 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008586 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008587 b.append(" }");
8588
8589 return b.toString();
8590 }
8591
8592 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008593 public String toInsecureString() {
8594 StringBuilder b = new StringBuilder(128);
8595
8596 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008597 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008598 b.append(" }");
8599
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008600 return b.toString();
8601 }
Romain Guy4969af72009-06-17 10:53:19 -07008602
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008603 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008604 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008605 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008606
8607 b.append("Intent { ");
8608 toShortString(b, false, true, true, true);
8609 b.append(" }");
8610
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008611 return b.toString();
8612 }
8613
8614 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008615 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8616 StringBuilder b = new StringBuilder(128);
8617 toShortString(b, secure, comp, extras, clip);
8618 return b.toString();
8619 }
8620
8621 /** @hide */
8622 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8623 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008624 boolean first = true;
8625 if (mAction != null) {
8626 b.append("act=").append(mAction);
8627 first = false;
8628 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008629 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008630 if (!first) {
8631 b.append(' ');
8632 }
8633 first = false;
8634 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008635 for (int i=0; i<mCategories.size(); i++) {
8636 if (i > 0) b.append(',');
8637 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008638 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008639 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008640 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008641 if (mData != null) {
8642 if (!first) {
8643 b.append(' ');
8644 }
8645 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008646 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008647 if (secure) {
8648 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008649 } else {
8650 b.append(mData);
8651 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008652 }
8653 if (mType != null) {
8654 if (!first) {
8655 b.append(' ');
8656 }
8657 first = false;
8658 b.append("typ=").append(mType);
8659 }
8660 if (mFlags != 0) {
8661 if (!first) {
8662 b.append(' ');
8663 }
8664 first = false;
8665 b.append("flg=0x").append(Integer.toHexString(mFlags));
8666 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008667 if (mPackage != null) {
8668 if (!first) {
8669 b.append(' ');
8670 }
8671 first = false;
8672 b.append("pkg=").append(mPackage);
8673 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008674 if (comp && mComponent != null) {
8675 if (!first) {
8676 b.append(' ');
8677 }
8678 first = false;
8679 b.append("cmp=").append(mComponent.flattenToShortString());
8680 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008681 if (mSourceBounds != null) {
8682 if (!first) {
8683 b.append(' ');
8684 }
8685 first = false;
8686 b.append("bnds=").append(mSourceBounds.toShortString());
8687 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008688 if (mClipData != null) {
8689 if (!first) {
8690 b.append(' ');
8691 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008692 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008693 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008694 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008695 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008696 if (mClipData.getDescription() != null) {
8697 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8698 } else {
8699 first = true;
8700 }
8701 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008702 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008703 first = false;
8704 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008705 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008706 if (extras && mExtras != null) {
8707 if (!first) {
8708 b.append(' ');
8709 }
8710 first = false;
8711 b.append("(has extras)");
8712 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008713 if (mContentUserHint != UserHandle.USER_CURRENT) {
8714 if (!first) {
8715 b.append(' ');
8716 }
8717 first = false;
8718 b.append("u=").append(mContentUserHint);
8719 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008720 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008721 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008722 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008723 b.append("}");
8724 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008725 }
8726
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008727 /**
8728 * Call {@link #toUri} with 0 flags.
8729 * @deprecated Use {@link #toUri} instead.
8730 */
8731 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008732 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008733 return toUri(0);
8734 }
8735
8736 /**
8737 * Convert this Intent into a String holding a URI representation of it.
8738 * The returned URI string has been properly URI encoded, so it can be
8739 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8740 * Intent's data as the base URI, with an additional fragment describing
8741 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008742 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008743 * <p>You can convert the returned string back to an Intent with
8744 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008745 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008746 * @param flags Additional operating flags. Either 0,
8747 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008748 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008749 * @return Returns a URI encoding URI string describing the entire contents
8750 * of the Intent.
8751 */
8752 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008753 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008754 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8755 if (mPackage == null) {
8756 throw new IllegalArgumentException(
8757 "Intent must include an explicit package name to build an android-app: "
8758 + this);
8759 }
8760 uri.append("android-app://");
8761 uri.append(mPackage);
8762 String scheme = null;
8763 if (mData != null) {
8764 scheme = mData.getScheme();
8765 if (scheme != null) {
8766 uri.append('/');
8767 uri.append(scheme);
8768 String authority = mData.getEncodedAuthority();
8769 if (authority != null) {
8770 uri.append('/');
8771 uri.append(authority);
8772 String path = mData.getEncodedPath();
8773 if (path != null) {
8774 uri.append(path);
8775 }
8776 String queryParams = mData.getEncodedQuery();
8777 if (queryParams != null) {
8778 uri.append('?');
8779 uri.append(queryParams);
8780 }
8781 String fragment = mData.getEncodedFragment();
8782 if (fragment != null) {
8783 uri.append('#');
8784 uri.append(fragment);
8785 }
8786 }
8787 }
8788 }
8789 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8790 mPackage, flags);
8791 return uri.toString();
8792 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008793 String scheme = null;
8794 if (mData != null) {
8795 String data = mData.toString();
8796 if ((flags&URI_INTENT_SCHEME) != 0) {
8797 final int N = data.length();
8798 for (int i=0; i<N; i++) {
8799 char c = data.charAt(i);
8800 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8801 || c == '.' || c == '-') {
8802 continue;
8803 }
8804 if (c == ':' && i > 0) {
8805 // Valid scheme.
8806 scheme = data.substring(0, i);
8807 uri.append("intent:");
8808 data = data.substring(i+1);
8809 break;
8810 }
Tom Taylord4a47292009-12-21 13:59:18 -08008811
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008812 // No scheme.
8813 break;
8814 }
8815 }
8816 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008817
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008818 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8819 uri.append("intent:");
8820 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008821
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008822 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008823
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008824 return uri.toString();
8825 }
8826
8827 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8828 String defPackage, int flags) {
8829 StringBuilder frag = new StringBuilder(128);
8830
8831 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008832 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008833 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008834 // Note that for now we are not going to try to handle the
8835 // data part; not clear how to represent this as a URI, and
8836 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008837 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8838 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008839 }
8840
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008841 if (frag.length() > 0) {
8842 uri.append("#Intent;");
8843 uri.append(frag);
8844 uri.append("end");
8845 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008846 }
8847
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008848 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8849 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008850 if (scheme != null) {
8851 uri.append("scheme=").append(scheme).append(';');
8852 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008853 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008854 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008855 }
8856 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008857 for (int i=0; i<mCategories.size(); i++) {
8858 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008859 }
8860 }
8861 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008862 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008863 }
8864 if (mFlags != 0) {
8865 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8866 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008867 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008868 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8869 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008870 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008871 uri.append("component=").append(Uri.encode(
8872 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008873 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008874 if (mSourceBounds != null) {
8875 uri.append("sourceBounds=")
8876 .append(Uri.encode(mSourceBounds.flattenToString()))
8877 .append(';');
8878 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008879 if (mExtras != null) {
8880 for (String key : mExtras.keySet()) {
8881 final Object value = mExtras.get(key);
8882 char entryType =
8883 value instanceof String ? 'S' :
8884 value instanceof Boolean ? 'B' :
8885 value instanceof Byte ? 'b' :
8886 value instanceof Character ? 'c' :
8887 value instanceof Double ? 'd' :
8888 value instanceof Float ? 'f' :
8889 value instanceof Integer ? 'i' :
8890 value instanceof Long ? 'l' :
8891 value instanceof Short ? 's' :
8892 '\0';
8893
8894 if (entryType != '\0') {
8895 uri.append(entryType);
8896 uri.append('.');
8897 uri.append(Uri.encode(key));
8898 uri.append('=');
8899 uri.append(Uri.encode(value.toString()));
8900 uri.append(';');
8901 }
8902 }
8903 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008904 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008905
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008906 public int describeContents() {
8907 return (mExtras != null) ? mExtras.describeContents() : 0;
8908 }
8909
8910 public void writeToParcel(Parcel out, int flags) {
8911 out.writeString(mAction);
8912 Uri.writeToParcel(out, mData);
8913 out.writeString(mType);
8914 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008915 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008916 ComponentName.writeToParcel(mComponent, out);
8917
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008918 if (mSourceBounds != null) {
8919 out.writeInt(1);
8920 mSourceBounds.writeToParcel(out, flags);
8921 } else {
8922 out.writeInt(0);
8923 }
8924
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008925 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008926 final int N = mCategories.size();
8927 out.writeInt(N);
8928 for (int i=0; i<N; i++) {
8929 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008930 }
8931 } else {
8932 out.writeInt(0);
8933 }
8934
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008935 if (mSelector != null) {
8936 out.writeInt(1);
8937 mSelector.writeToParcel(out, flags);
8938 } else {
8939 out.writeInt(0);
8940 }
8941
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008942 if (mClipData != null) {
8943 out.writeInt(1);
8944 mClipData.writeToParcel(out, flags);
8945 } else {
8946 out.writeInt(0);
8947 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008948 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008949 out.writeBundle(mExtras);
8950 }
8951
8952 public static final Parcelable.Creator<Intent> CREATOR
8953 = new Parcelable.Creator<Intent>() {
8954 public Intent createFromParcel(Parcel in) {
8955 return new Intent(in);
8956 }
8957 public Intent[] newArray(int size) {
8958 return new Intent[size];
8959 }
8960 };
8961
Dianne Hackborneb034652009-09-07 00:49:58 -07008962 /** @hide */
8963 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008964 readFromParcel(in);
8965 }
8966
8967 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008968 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008969 mData = Uri.CREATOR.createFromParcel(in);
8970 mType = in.readString();
8971 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008972 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008973 mComponent = ComponentName.readFromParcel(in);
8974
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008975 if (in.readInt() != 0) {
8976 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8977 }
8978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008979 int N = in.readInt();
8980 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008981 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008982 int i;
8983 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008984 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008985 }
8986 } else {
8987 mCategories = null;
8988 }
8989
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008990 if (in.readInt() != 0) {
8991 mSelector = new Intent(in);
8992 }
8993
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008994 if (in.readInt() != 0) {
8995 mClipData = new ClipData(in);
8996 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008997 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008998 mExtras = in.readBundle();
8999 }
9000
9001 /**
9002 * Parses the "intent" element (and its children) from XML and instantiates
9003 * an Intent object. The given XML parser should be located at the tag
9004 * where parsing should start (often named "intent"), from which the
9005 * basic action, data, type, and package and class name will be
9006 * retrieved. The function will then parse in to any child elements,
9007 * looking for <category android:name="xxx"> tags to add categories and
9008 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9009 * to the intent.
9010 *
9011 * @param resources The Resources to use when inflating resources.
9012 * @param parser The XML parser pointing at an "intent" tag.
9013 * @param attrs The AttributeSet interface for retrieving extended
9014 * attribute data at the current <var>parser</var> location.
9015 * @return An Intent object matching the XML data.
9016 * @throws XmlPullParserException If there was an XML parsing error.
9017 * @throws IOException If there was an I/O error.
9018 */
9019 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
9020 throws XmlPullParserException, IOException {
9021 Intent intent = new Intent();
9022
9023 TypedArray sa = resources.obtainAttributes(attrs,
9024 com.android.internal.R.styleable.Intent);
9025
9026 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9027
9028 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9029 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9030 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9031
9032 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9033 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9034 if (packageName != null && className != null) {
9035 intent.setComponent(new ComponentName(packageName, className));
9036 }
9037
9038 sa.recycle();
9039
9040 int outerDepth = parser.getDepth();
9041 int type;
9042 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9043 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9044 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9045 continue;
9046 }
9047
9048 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009049 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009050 sa = resources.obtainAttributes(attrs,
9051 com.android.internal.R.styleable.IntentCategory);
9052 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9053 sa.recycle();
9054
9055 if (cat != null) {
9056 intent.addCategory(cat);
9057 }
9058 XmlUtils.skipCurrentTag(parser);
9059
Craig Mautner21d24a22014-04-23 11:45:37 -07009060 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009061 if (intent.mExtras == null) {
9062 intent.mExtras = new Bundle();
9063 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009064 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009065 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009066
9067 } else {
9068 XmlUtils.skipCurrentTag(parser);
9069 }
9070 }
9071
9072 return intent;
9073 }
Nick Pellyccae4122012-01-09 14:12:58 -08009074
Craig Mautner21d24a22014-04-23 11:45:37 -07009075 /** @hide */
9076 public void saveToXml(XmlSerializer out) throws IOException {
9077 if (mAction != null) {
9078 out.attribute(null, ATTR_ACTION, mAction);
9079 }
9080 if (mData != null) {
9081 out.attribute(null, ATTR_DATA, mData.toString());
9082 }
9083 if (mType != null) {
9084 out.attribute(null, ATTR_TYPE, mType);
9085 }
9086 if (mComponent != null) {
9087 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9088 }
9089 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9090
9091 if (mCategories != null) {
9092 out.startTag(null, TAG_CATEGORIES);
9093 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9094 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9095 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009096 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009097 }
9098 }
9099
9100 /** @hide */
9101 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9102 XmlPullParserException {
9103 Intent intent = new Intent();
9104 final int outerDepth = in.getDepth();
9105
9106 int attrCount = in.getAttributeCount();
9107 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9108 final String attrName = in.getAttributeName(attrNdx);
9109 final String attrValue = in.getAttributeValue(attrNdx);
9110 if (ATTR_ACTION.equals(attrName)) {
9111 intent.setAction(attrValue);
9112 } else if (ATTR_DATA.equals(attrName)) {
9113 intent.setData(Uri.parse(attrValue));
9114 } else if (ATTR_TYPE.equals(attrName)) {
9115 intent.setType(attrValue);
9116 } else if (ATTR_COMPONENT.equals(attrName)) {
9117 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9118 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009119 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009120 } else {
9121 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9122 }
9123 }
9124
9125 int event;
9126 String name;
9127 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9128 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9129 if (event == XmlPullParser.START_TAG) {
9130 name = in.getName();
9131 if (TAG_CATEGORIES.equals(name)) {
9132 attrCount = in.getAttributeCount();
9133 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9134 intent.addCategory(in.getAttributeValue(attrNdx));
9135 }
9136 } else {
9137 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9138 XmlUtils.skipCurrentTag(in);
9139 }
9140 }
9141 }
9142
9143 return intent;
9144 }
9145
Nick Pellyccae4122012-01-09 14:12:58 -08009146 /**
9147 * Normalize a MIME data type.
9148 *
9149 * <p>A normalized MIME type has white-space trimmed,
9150 * content-type parameters removed, and is lower-case.
9151 * This aligns the type with Android best practices for
9152 * intent filtering.
9153 *
9154 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9155 * "text/x-vCard" becomes "text/x-vcard".
9156 *
9157 * <p>All MIME types received from outside Android (such as user input,
9158 * or external sources like Bluetooth, NFC, or the Internet) should
9159 * be normalized before they are used to create an Intent.
9160 *
9161 * @param type MIME data type to normalize
9162 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009163 * @see #setType
9164 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009165 */
9166 public static String normalizeMimeType(String type) {
9167 if (type == null) {
9168 return null;
9169 }
9170
Elliott Hughescb64d432013-08-02 10:00:44 -07009171 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009172
9173 final int semicolonIndex = type.indexOf(';');
9174 if (semicolonIndex != -1) {
9175 type = type.substring(0, semicolonIndex);
9176 }
9177 return type;
9178 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009179
9180 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009181 * Prepare this {@link Intent} to leave an app process.
9182 *
9183 * @hide
9184 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009185 public void prepareToLeaveProcess(Context context) {
9186 final boolean leavingPackage = (mComponent == null)
9187 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9188 prepareToLeaveProcess(leavingPackage);
9189 }
9190
9191 /**
9192 * Prepare this {@link Intent} to leave an app process.
9193 *
9194 * @hide
9195 */
9196 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009197 setAllowFds(false);
9198
9199 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009200 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009201 }
9202 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009203 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009204 }
9205
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009206 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9207 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009208 switch (mAction) {
9209 case ACTION_MEDIA_REMOVED:
9210 case ACTION_MEDIA_UNMOUNTED:
9211 case ACTION_MEDIA_CHECKING:
9212 case ACTION_MEDIA_NOFS:
9213 case ACTION_MEDIA_MOUNTED:
9214 case ACTION_MEDIA_SHARED:
9215 case ACTION_MEDIA_UNSHARED:
9216 case ACTION_MEDIA_BAD_REMOVAL:
9217 case ACTION_MEDIA_UNMOUNTABLE:
9218 case ACTION_MEDIA_EJECT:
9219 case ACTION_MEDIA_SCANNER_STARTED:
9220 case ACTION_MEDIA_SCANNER_FINISHED:
9221 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009222 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9223 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009224 // Ignore legacy actions
9225 break;
9226 default:
9227 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009228 }
9229 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009230
9231 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9232 && leavingPackage) {
9233 switch (mAction) {
9234 case ACTION_PROVIDER_CHANGED:
9235 // Ignore actions that don't need to grant
9236 break;
9237 default:
9238 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9239 }
9240 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009241 }
9242
9243 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009244 * @hide
9245 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009246 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009247 // We just entered destination process, so we should be able to read all
9248 // parcelables inside.
9249 setDefusable(true);
9250
9251 if (mSelector != null) {
9252 mSelector.prepareToEnterProcess();
9253 }
9254 if (mClipData != null) {
9255 mClipData.prepareToEnterProcess();
9256 }
9257
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009258 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009259 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9260 fixUris(mContentUserHint);
9261 mContentUserHint = UserHandle.USER_CURRENT;
9262 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009263 }
9264 }
9265
9266 /**
9267 * @hide
9268 */
9269 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009270 Uri data = getData();
9271 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009272 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009273 }
9274 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009275 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009276 }
9277 String action = getAction();
9278 if (ACTION_SEND.equals(action)) {
9279 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9280 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009281 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009282 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009283 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009284 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9285 if (streams != null) {
9286 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9287 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009288 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009289 }
9290 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9291 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009292 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9293 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9294 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9295 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9296 if (output != null) {
9297 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9298 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009299 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009300 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009301
9302 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009303 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009304 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9305 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009306 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009307 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009308 * @hide
9309 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009310 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009311 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009312 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009313
9314 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009315 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009316
9317 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009318 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009319 // Inspect contained intents to see if we need to migrate extras. We
9320 // don't promote ClipData to the parent, since ChooserActivity will
9321 // already start the picked item as the caller, and we can't combine
9322 // the flags in a safe way.
9323
9324 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009325 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009326 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9327 if (intent != null) {
9328 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009329 }
9330 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009331 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009332 try {
9333 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9334 if (intents != null) {
9335 for (int i = 0; i < intents.length; i++) {
9336 final Intent intent = (Intent) intents[i];
9337 if (intent != null) {
9338 migrated |= intent.migrateExtraStreamToClipData();
9339 }
9340 }
9341 }
9342 } catch (ClassCastException e) {
9343 }
9344 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009345
9346 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009347 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009348 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9349 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9350 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9351 if (stream != null || text != null || htmlText != null) {
9352 final ClipData clipData = new ClipData(
9353 null, new String[] { getType() },
9354 new ClipData.Item(text, htmlText, null, stream));
9355 setClipData(clipData);
9356 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009357 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009358 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009359 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009360 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009361
9362 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009363 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009364 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9365 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9366 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9367 int num = -1;
9368 if (streams != null) {
9369 num = streams.size();
9370 }
9371 if (texts != null) {
9372 if (num >= 0 && num != texts.size()) {
9373 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009374 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009375 }
9376 num = texts.size();
9377 }
9378 if (htmlTexts != null) {
9379 if (num >= 0 && num != htmlTexts.size()) {
9380 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009381 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009382 }
9383 num = htmlTexts.size();
9384 }
9385 if (num > 0) {
9386 final ClipData clipData = new ClipData(
9387 null, new String[] { getType() },
9388 makeClipItem(streams, texts, htmlTexts, 0));
9389
9390 for (int i = 1; i < num; i++) {
9391 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9392 }
9393
9394 setClipData(clipData);
9395 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009396 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009397 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009398 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009399 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009400 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9401 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9402 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9403 final Uri output;
9404 try {
9405 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9406 } catch (ClassCastException e) {
9407 return false;
9408 }
9409 if (output != null) {
9410 setClipData(ClipData.newRawUri("", output));
9411 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9412 return true;
9413 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009414 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009415
9416 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009417 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009418
9419 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9420 ArrayList<String> htmlTexts, int which) {
9421 Uri uri = streams != null ? streams.get(which) : null;
9422 CharSequence text = texts != null ? texts.get(which) : null;
9423 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9424 return new ClipData.Item(text, htmlText, null, uri);
9425 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009426
9427 /** @hide */
9428 public boolean isDocument() {
9429 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9430 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009431}