blob: c5500949b25fe1fab7e8a5aab871c124fc853204 [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 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001631 * Specify whether the package should be uninstalled for all users.
1632 * @hide because these should not be part of normal application flow.
1633 */
1634 public static final String EXTRA_UNINSTALL_ALL_USERS
1635 = "android.intent.extra.UNINSTALL_ALL_USERS";
1636
1637 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001638 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1639 * describing the last run version of the platform that was setup.
1640 * @hide
1641 */
1642 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1643
Svet Ganov3695b8a2015-03-24 16:30:25 -07001644 /**
1645 * Activity action: Launch UI to manage the permissions of an app.
1646 * <p>
1647 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1648 * will be managed by the launched UI.
1649 * </p>
1650 * <p>
1651 * Output: Nothing.
1652 * </p>
1653 *
1654 * @see #EXTRA_PACKAGE_NAME
1655 *
1656 * @hide
1657 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001658 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001659 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1660 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1661 "android.intent.action.MANAGE_APP_PERMISSIONS";
1662
1663 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001664 * Activity action: Launch UI to manage permissions.
1665 * <p>
1666 * Input: Nothing.
1667 * </p>
1668 * <p>
1669 * Output: Nothing.
1670 * </p>
1671 *
1672 * @hide
1673 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001674 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001675 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1676 public static final String ACTION_MANAGE_PERMISSIONS =
1677 "android.intent.action.MANAGE_PERMISSIONS";
1678
1679 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001680 * Activity action: Launch UI to review permissions for an app.
1681 * The system uses this intent if permission review for apps not
1682 * supporting the new runtime permissions model is enabled. In
1683 * this mode a permission review is required before any of the
1684 * app components can run.
1685 * <p>
1686 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1687 * permissions will be reviewed (mandatory).
1688 * </p>
1689 * <p>
1690 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1691 * be fired after the permission review (optional).
1692 * </p>
1693 * <p>
1694 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1695 * be invoked after the permission review (optional).
1696 * </p>
1697 * <p>
1698 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1699 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1700 * </p>
1701 * <p>
1702 * Output: Nothing.
1703 * </p>
1704 *
1705 * @see #EXTRA_PACKAGE_NAME
1706 * @see #EXTRA_INTENT
1707 * @see #EXTRA_REMOTE_CALLBACK
1708 * @see #EXTRA_RESULT_NEEDED
1709 *
1710 * @hide
1711 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001712 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001713 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1714 public static final String ACTION_REVIEW_PERMISSIONS =
1715 "android.intent.action.REVIEW_PERMISSIONS";
1716
1717 /**
1718 * Intent extra: A callback for reporting remote result as a bundle.
1719 * <p>
1720 * Type: IRemoteCallback
1721 * </p>
1722 *
1723 * @hide
1724 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001725 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001726 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1727
1728 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001729 * Intent extra: An app package name.
1730 * <p>
1731 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001732 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001733 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001734 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001735 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1736
1737 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001738 * Intent extra: An app split name.
1739 * <p>
1740 * Type: String
1741 * </p>
1742 * @hide
1743 */
1744 @SystemApi
1745 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1746
1747 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001748 * Intent extra: An extra for specifying whether a result is needed.
1749 * <p>
1750 * Type: boolean
1751 * </p>
1752 *
1753 * @hide
1754 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001755 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001756 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1757
1758 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001759 * Activity action: Launch UI to manage which apps have a given permission.
1760 * <p>
1761 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1762 * to which will be managed by the launched UI.
1763 * </p>
1764 * <p>
1765 * Output: Nothing.
1766 * </p>
1767 *
1768 * @see #EXTRA_PERMISSION_NAME
1769 *
1770 * @hide
1771 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001772 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001773 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1774 public static final String ACTION_MANAGE_PERMISSION_APPS =
1775 "android.intent.action.MANAGE_PERMISSION_APPS";
1776
1777 /**
1778 * Intent extra: The name of a permission.
1779 * <p>
1780 * Type: String
1781 * </p>
1782 *
1783 * @hide
1784 */
1785 @SystemApi
1786 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1787
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001788 // ---------------------------------------------------------------------
1789 // ---------------------------------------------------------------------
1790 // Standard intent broadcast actions (see action variable).
1791
1792 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001793 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1794 * <p>
1795 * For historical reasons, the name of this broadcast action refers to the power
1796 * state of the screen but it is actually sent in response to changes in the
1797 * overall interactive state of the device.
1798 * </p><p>
1799 * This broadcast is sent when the device becomes non-interactive which may have
1800 * nothing to do with the screen turning off. To determine the
1801 * actual state of the screen, use {@link android.view.Display#getState}.
1802 * </p><p>
1803 * See {@link android.os.PowerManager#isInteractive} for details.
1804 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001805 * You <em>cannot</em> receive this through components declared in
1806 * manifests, only by explicitly registering for it with
1807 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1808 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001809 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001810 * <p class="note">This is a protected intent that can only be sent
1811 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001812 */
1813 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1814 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001815
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001816 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001817 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1818 * <p>
1819 * For historical reasons, the name of this broadcast action refers to the power
1820 * state of the screen but it is actually sent in response to changes in the
1821 * overall interactive state of the device.
1822 * </p><p>
1823 * This broadcast is sent when the device becomes interactive which may have
1824 * nothing to do with the screen turning on. To determine the
1825 * actual state of the screen, use {@link android.view.Display#getState}.
1826 * </p><p>
1827 * See {@link android.os.PowerManager#isInteractive} for details.
1828 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001829 * You <em>cannot</em> receive this through components declared in
1830 * manifests, only by explicitly registering for it with
1831 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1832 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001833 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001834 * <p class="note">This is a protected intent that can only be sent
1835 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 */
1837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1838 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001839
1840 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001841 * Broadcast Action: Sent after the system stops dreaming.
1842 *
1843 * <p class="note">This is a protected intent that can only be sent by the system.
1844 * It is only sent to registered receivers.</p>
1845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1848
1849 /**
1850 * Broadcast Action: Sent after the system starts dreaming.
1851 *
1852 * <p class="note">This is a protected intent that can only be sent by the system.
1853 * It is only sent to registered receivers.</p>
1854 */
1855 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1856 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1857
1858 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001859 * 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 -07001860 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001861 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001862 * <p class="note">This is a protected intent that can only be sent
1863 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001864 */
1865 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001866 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001867
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001868 /**
1869 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001870 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001871 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001872 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1873 * Context.registerReceiver()}.
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 Project54b6cfa2008-10-21 07:00:00 -07001877 */
1878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1879 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1880 /**
1881 * Broadcast Action: The time was set.
1882 */
1883 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1884 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1885 /**
1886 * Broadcast Action: The date has changed.
1887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1889 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1890 /**
1891 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1892 * <ul>
1893 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1894 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001895 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001896 * <p class="note">This is a protected intent that can only be sent
1897 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001898 */
1899 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1900 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1901 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001902 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1903 * DNS entries should be tossed.
1904 * @hide
1905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1907 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1908 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001909 * Alarm Changed Action: This is broadcast when the AlarmClock
1910 * application's alarm is set or unset. It is used by the
1911 * AlarmClock application and the StatusBar service.
1912 * @hide
1913 */
1914 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1915 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001916
1917 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001918 * Broadcast Action: This is broadcast once, after the user has finished
1919 * booting, but while still in the "locked" state. It can be used to perform
1920 * application-specific initialization, such as installing alarms. You must
1921 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1922 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001923 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001924 * This broadcast is sent immediately at boot by all devices (regardless of
1925 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1926 * higher. Upon receipt of this broadcast, the user is still locked and only
1927 * device-protected storage can be accessed safely. If you want to access
1928 * credential-protected storage, you need to wait for the user to be
1929 * unlocked (typically by entering their lock pattern or PIN for the first
1930 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1931 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1932 * <p>
1933 * To receive this broadcast, your receiver component must be marked as
1934 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001935 * <p class="note">
1936 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001937 *
1938 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001939 */
1940 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1941 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1942
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001943 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001944 * Broadcast Action: This is broadcast once, after the user has finished
1945 * booting. It can be used to perform application-specific initialization,
1946 * such as installing alarms. You must hold the
1947 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1948 * order to receive this broadcast.
1949 * <p>
1950 * This broadcast is sent at boot by all devices (both with and without
1951 * direct boot support). Upon receipt of this broadcast, the user is
1952 * unlocked and both device-protected and credential-protected storage can
1953 * accessed safely.
1954 * <p>
1955 * If you need to run while the user is still locked (before they've entered
1956 * their lock pattern or PIN for the first time), you can listen for the
1957 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1958 * <p class="note">
1959 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001960 */
1961 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1962 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001963
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001964 /**
1965 * Broadcast Action: This is broadcast when a user action should request a
1966 * temporary system dialog to dismiss. Some examples of temporary system
1967 * dialogs are the notification window-shade and the recent tasks dialog.
1968 */
1969 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1970 /**
1971 * Broadcast Action: Trigger the download and eventual installation
1972 * of a package.
1973 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001974 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001975 * <p class="note">This is a protected intent that can only be sent
1976 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001977 *
1978 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001980 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1983 /**
1984 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001985 * device. The data contains the name of the package. Note that the
1986 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001987 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001988 * <ul>
1989 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1990 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1991 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1992 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001993 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001994 * <p class="note">This is a protected intent that can only be sent
1995 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001996 */
1997 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1998 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1999 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002000 * Broadcast Action: A new version of an application package has been
2001 * installed, replacing an existing version that was previously installed.
2002 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002003 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002004 * <ul>
2005 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2006 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002007 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002008 * <p class="note">This is a protected intent that can only be sent
2009 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002010 */
2011 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2012 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2013 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002014 * Broadcast Action: A new version of your application has been installed
2015 * over an existing one. This is only sent to the application that was
2016 * replaced. It does not contain any additional data; to receive it, just
2017 * use an intent filter for this action.
2018 *
2019 * <p class="note">This is a protected intent that can only be sent
2020 * by the system.
2021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2024 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002025 * Broadcast Action: An existing application package has been removed from
2026 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002027 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002028 * <ul>
2029 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2030 * to the package.
2031 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2032 * application -- data and code -- is being removed.
2033 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2034 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2035 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002036 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002037 * <p class="note">This is a protected intent that can only be sent
2038 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2042 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002043 * Broadcast Action: An existing application package has been completely
2044 * removed from the device. The data contains the name of the package.
2045 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2046 * {@link #EXTRA_DATA_REMOVED} is true and
2047 * {@link #EXTRA_REPLACING} is false of that broadcast.
2048 *
2049 * <ul>
2050 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2051 * to the package.
2052 * </ul>
2053 *
2054 * <p class="note">This is a protected intent that can only be sent
2055 * by the system.
2056 */
2057 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2058 public static final String ACTION_PACKAGE_FULLY_REMOVED
2059 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2060 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002061 * Broadcast Action: An existing application package has been changed (for
2062 * example, a component has been enabled or disabled). The data contains
2063 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002064 * <ul>
2065 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002066 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002067 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002068 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2069 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002070 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002071 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002072 * <p class="note">This is a protected intent that can only be sent
2073 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2077 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002078 * @hide
2079 * Broadcast Action: Ask system services if there is any reason to
2080 * restart the given package. The data contains the name of the
2081 * package.
2082 * <ul>
2083 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2084 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2085 * </ul>
2086 *
2087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
2089 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002090 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2093 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002094 * Broadcast Action: The user has restarted a package, and all of its
2095 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002097 * be removed. Note that the restarted package does <em>not</em>
2098 * receive this broadcast.
2099 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002100 * <ul>
2101 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2102 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002103 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002104 * <p class="note">This is a protected intent that can only be sent
2105 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2109 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002110 * Broadcast Action: The user has cleared the data of a package. This should
2111 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002112 * its persistent data is erased and this broadcast sent.
2113 * Note that the cleared package does <em>not</em>
2114 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002115 * <ul>
2116 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2117 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002118 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002119 * <p class="note">This is a protected intent that can only be sent
2120 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002121 */
2122 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2123 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2124 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002125 * Broadcast Action: Packages have been suspended.
2126 * <p>Includes the following extras:
2127 * <ul>
2128 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2129 * </ul>
2130 *
2131 * <p class="note">This is a protected intent that can only be sent
2132 * by the system. It is only sent to registered receivers.
2133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2136 /**
2137 * Broadcast Action: Packages have been unsuspended.
2138 * <p>Includes the following extras:
2139 * <ul>
2140 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2141 * </ul>
2142 *
2143 * <p class="note">This is a protected intent that can only be sent
2144 * by the system. It is only sent to registered receivers.
2145 */
2146 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2147 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2148 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002149 * Broadcast Action: A user ID has been removed from the system. The user
2150 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002151 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002152 * <p class="note">This is a protected intent that can only be sent
2153 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002154 */
2155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2156 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002157
2158 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002159 * Broadcast Action: Sent to the installer package of an application when
2160 * that application is first launched (that is the first time it is moved
2161 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002162 *
2163 * <p class="note">This is a protected intent that can only be sent
2164 * by the system.
2165 */
2166 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2167 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2168
2169 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002170 * Broadcast Action: Sent to the system package verifier when a package
2171 * needs to be verified. The data contains the package URI.
2172 * <p class="note">
2173 * This is a protected intent that can only be sent by the system.
2174 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002175 */
2176 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2177 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2178
2179 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002180 * Broadcast Action: Sent to the system package verifier when a package is
2181 * verified. The data contains the package URI.
2182 * <p class="note">
2183 * This is a protected intent that can only be sent by the system.
2184 */
2185 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2186 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2187
2188 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002189 * Broadcast Action: Sent to the system intent filter verifier when an
2190 * intent filter needs to be verified. The data contains the filter data
2191 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002192 * <p class="note">
2193 * This is a protected intent that can only be sent by the system.
2194 * </p>
2195 *
2196 * @hide
2197 */
2198 @SystemApi
2199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2200 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2201
2202 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002203 * Broadcast Action: Resources for a set of packages (which were
2204 * previously unavailable) are currently
2205 * available since the media on which they exist is available.
2206 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2207 * list of packages whose availability changed.
2208 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2209 * list of uids of packages whose availability changed.
2210 * Note that the
2211 * packages in this list do <em>not</em> receive this broadcast.
2212 * The specified set of packages are now available on the system.
2213 * <p>Includes the following extras:
2214 * <ul>
2215 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2216 * whose resources(were previously unavailable) are currently available.
2217 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2218 * packages whose resources(were previously unavailable)
2219 * are currently available.
2220 * </ul>
2221 *
2222 * <p class="note">This is a protected intent that can only be sent
2223 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002224 */
2225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002226 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2227 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002228
2229 /**
2230 * Broadcast Action: Resources for a set of packages are currently
2231 * unavailable since the media on which they exist is unavailable.
2232 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2233 * list of packages whose availability changed.
2234 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2235 * list of uids of packages whose availability changed.
2236 * The specified set of packages can no longer be
2237 * launched and are practically unavailable on the system.
2238 * <p>Inclues the following extras:
2239 * <ul>
2240 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2241 * whose resources are no longer available.
2242 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2243 * whose resources are no longer available.
2244 * </ul>
2245 *
2246 * <p class="note">This is a protected intent that can only be sent
2247 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002248 */
2249 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002250 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002251 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002252
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002253 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002254 * Broadcast Action: preferred activities have changed *explicitly*.
2255 *
2256 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2257 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2258 * be sent.
2259 *
2260 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2261 *
2262 * @hide
2263 */
2264 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2265 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2266 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2267
2268
2269 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002270 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002271 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002272 * This should <em>only</em> be used to determine when the wallpaper
2273 * has changed to show the new wallpaper to the user. You should certainly
2274 * never, in response to this, change the wallpaper or other attributes of
2275 * it such as the suggested size. That would be crazy, right? You'd cause
2276 * all kinds of loops, especially if other apps are doing similar things,
2277 * right? Of course. So please don't do this.
2278 *
2279 * @deprecated Modern applications should use
2280 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2281 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2282 * shown behind their UI, rather than watching for this broadcast and
2283 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002284 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002285 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002286 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2287 /**
2288 * Broadcast Action: The current device {@link android.content.res.Configuration}
2289 * (orientation, locale, etc) has changed. When such a change happens, the
2290 * UIs (view hierarchy) will need to be rebuilt based on this new
2291 * information; for the most part, applications don't need to worry about
2292 * this, because the system will take care of stopping and restarting the
2293 * application to make sure it sees the new changes. Some system code that
2294 * can not be restarted will need to watch for this action and handle it
2295 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002296 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002297 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002298 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002299 * in manifests, only by explicitly registering for it with
2300 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2301 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002302 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002303 * <p class="note">This is a protected intent that can only be sent
2304 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002305 *
2306 * @see android.content.res.Configuration
2307 */
2308 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2309 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2310 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002311 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002312 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002313 * <p class="note">This is a protected intent that can only be sent
2314 * by the system.
2315 */
2316 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2317 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2318 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002319 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2320 * charging state, level, and other information about the battery.
2321 * See {@link android.os.BatteryManager} for documentation on the
2322 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002323 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002325 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002326 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002327 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002328 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2329 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2330 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2331 * broadcasts that are sent and can be received through manifest
2332 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002333 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002334 * <p class="note">This is a protected intent that can only be sent
2335 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002336 */
2337 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2338 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2339 /**
2340 * Broadcast Action: Indicates low battery condition on the device.
2341 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002342 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002343 * <p class="note">This is a protected intent that can only be sent
2344 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2347 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2348 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002349 * Broadcast Action: Indicates the battery is now okay after being low.
2350 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2351 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002352 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002353 * <p class="note">This is a protected intent that can only be sent
2354 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002355 */
2356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2357 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2358 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002359 * Broadcast Action: External power has been connected to the device.
2360 * This is intended for applications that wish to register specifically to this notification.
2361 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2362 * stay active to receive this notification. This action can be used to implement actions
2363 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002364 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002365 * <p class="note">This is a protected intent that can only be sent
2366 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002367 */
2368 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002369 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002370 /**
2371 * Broadcast Action: External power has been removed from the device.
2372 * This is intended for applications that wish to register specifically to this notification.
2373 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2374 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002375 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002376 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002377 * <p class="note">This is a protected intent that can only be sent
2378 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002379 */
2380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002381 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002382 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002383 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002384 * Broadcast Action: Device is shutting down.
2385 * This is broadcast when the device is being shut down (completely turned
2386 * off, not sleeping). Once the broadcast is complete, the final shutdown
2387 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002388 * to handle this, since the foreground activity will be paused as well.
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.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002392 * <p>May include the following extras:
2393 * <ul>
2394 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2395 * shutdown is only for userspace processes. If not set, assumed to be false.
2396 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002397 */
2398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002399 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002400 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002401 * Activity Action: Start this activity to request system shutdown.
2402 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002403 * to request confirmation from the user before shutting down. The optional boolean
2404 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2405 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002406 *
2407 * <p class="note">This is a protected intent that can only be sent
2408 * by the system.
2409 *
2410 * {@hide}
2411 */
2412 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2413 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002414 * Broadcast Action: A sticky broadcast that indicates low memory
2415 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002416 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002417 * <p class="note">This is a protected intent that can only be sent
2418 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002419 */
2420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2421 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2422 /**
2423 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002424 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002425 * <p class="note">This is a protected intent that can only be sent
2426 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002427 */
2428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2429 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2430 /**
Jake Hambybb371632010-08-23 18:16:48 -07002431 * Broadcast Action: A sticky broadcast that indicates a memory full
2432 * condition on the device. This is intended for activities that want
2433 * to be able to fill the data partition completely, leaving only
2434 * enough free space to prevent system-wide SQLite failures.
2435 *
2436 * <p class="note">This is a protected intent that can only be sent
2437 * by the system.
2438 *
2439 * {@hide}
2440 */
2441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2442 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2443 /**
2444 * Broadcast Action: Indicates memory full condition on the device
2445 * no longer exists.
2446 *
2447 * <p class="note">This is a protected intent that can only be sent
2448 * by the system.
2449 *
2450 * {@hide}
2451 */
2452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2453 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2454 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002455 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2456 * and package management should be started.
2457 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2458 * notification.
2459 */
2460 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2461 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2462 /**
2463 * Broadcast Action: The device has entered USB Mass Storage mode.
2464 * This is used mainly for the USB Settings panel.
2465 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2466 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002467 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002468 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002469 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002470 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2471
2472 /**
2473 * Broadcast Action: The device has exited USB Mass Storage mode.
2474 * This is used mainly for the USB Settings panel.
2475 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2476 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002477 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002478 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002479 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002480 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2481
2482 /**
2483 * Broadcast Action: External media has been removed.
2484 * The path to the mount point for the removed media is contained in the Intent.mData field.
2485 */
2486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2487 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2488
2489 /**
2490 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002491 * 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 -07002492 */
2493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2494 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2495
2496 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002497 * Broadcast Action: External media is present, and being disk-checked
2498 * 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 -08002499 */
2500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2501 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2502
2503 /**
2504 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2505 * 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 -08002506 */
2507 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2508 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2509
2510 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002511 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002512 * 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 -07002513 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2514 * media was mounted read only.
2515 */
2516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2517 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2518
2519 /**
2520 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002521 * 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 -07002522 */
2523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2524 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2525
2526 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002527 * Broadcast Action: External media is no longer being shared via USB mass storage.
2528 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2529 *
2530 * @hide
2531 */
2532 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2533
2534 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002535 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2536 * The path to the mount point for the removed media is contained in the Intent.mData field.
2537 */
2538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2539 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2540
2541 /**
2542 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002543 * 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 -07002544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2546 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2547
2548 /**
2549 * Broadcast Action: User has expressed the desire to remove the external storage media.
2550 * Applications should close all files they have open within the mount point when they receive this intent.
2551 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2552 */
2553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2554 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2555
2556 /**
2557 * Broadcast Action: The media scanner has started scanning a directory.
2558 * The path to the directory being scanned is contained in the Intent.mData field.
2559 */
2560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2561 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2562
2563 /**
2564 * Broadcast Action: The media scanner has finished scanning a directory.
2565 * The path to the scanned directory is contained in the Intent.mData field.
2566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2569
2570 /**
2571 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2572 * The path to the file is contained in the Intent.mData field.
2573 */
2574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2575 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2576
2577 /**
2578 * Broadcast Action: The "Media Button" was pressed. Includes a single
2579 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2580 * caused the broadcast.
2581 */
2582 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2583 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2584
2585 /**
2586 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2587 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2588 * caused the broadcast.
2589 */
2590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2591 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2592
2593 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2594 // location; they are not general-purpose actions.
2595
2596 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002597 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002598 */
2599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2600 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2601 "android.intent.action.GTALK_CONNECTED";
2602
2603 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002604 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002605 */
2606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2607 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2608 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002609
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002610 /**
2611 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002612 */
2613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2614 public static final String ACTION_INPUT_METHOD_CHANGED =
2615 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002616
2617 /**
2618 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2619 * more radios have been turned off or on. The intent will have the following extra value:</p>
2620 * <ul>
2621 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2622 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2623 * turned off</li>
2624 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002625 *
Peng Xua35b5532016-01-20 00:05:45 -08002626 * <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 -07002627 */
2628 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2629 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2630
2631 /**
2632 * Broadcast Action: Some content providers have parts of their namespace
2633 * where they publish new events or items that the user may be especially
2634 * interested in. For these things, they may broadcast this action when the
2635 * set of interesting items change.
2636 *
2637 * For example, GmailProvider sends this notification when the set of unread
2638 * mail in the inbox changes.
2639 *
2640 * <p>The data of the intent identifies which part of which provider
2641 * changed. When queried through the content resolver, the data URI will
2642 * return the data set in question.
2643 *
2644 * <p>The intent will have the following extra values:
2645 * <ul>
2646 * <li><em>count</em> - The number of items in the data set. This is the
2647 * same as the number of items in the cursor returned by querying the
2648 * data URI. </li>
2649 * </ul>
2650 *
2651 * This intent will be sent at boot (if the count is non-zero) and when the
2652 * data set changes. It is possible for the data set to change without the
2653 * count changing (for example, if a new unread message arrives in the same
2654 * sync operation in which a message is archived). The phone should still
2655 * ring/vibrate/etc as normal in this case.
2656 */
2657 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2658 public static final String ACTION_PROVIDER_CHANGED =
2659 "android.intent.action.PROVIDER_CHANGED";
2660
2661 /**
2662 * Broadcast Action: Wired Headset plugged in or unplugged.
2663 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002664 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2665 * and documentation.
2666 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002667 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002668 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002669 */
2670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002671 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002672
2673 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002674 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2675 * <ul>
2676 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2677 * </ul>
2678 *
2679 * <p class="note">This is a protected intent that can only be sent
2680 * by the system.
2681 *
2682 * @hide
2683 */
2684 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2685 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2686 = "android.intent.action.ADVANCED_SETTINGS";
2687
2688 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002689 * Broadcast Action: Sent after application restrictions are changed.
2690 *
2691 * <p class="note">This is a protected intent that can only be sent
2692 * by the system.</p>
2693 */
2694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2695 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2696 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2697
2698 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002699 * Broadcast Action: An outgoing call is about to be placed.
2700 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002701 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002702 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002703 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002704 * the phone number originally intended to be dialed.</li>
2705 * </ul>
2706 * <p>Once the broadcast is finished, the resultData is used as the actual
2707 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002708 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002709 * outgoing call in turn: for example, a parental control application
2710 * might verify that the user is authorized to place the call at that
2711 * time, then a number-rewriting application might add an area code if
2712 * one was not specified.</p>
2713 * <p>For consistency, any receiver whose purpose is to prohibit phone
2714 * calls should have a priority of 0, to ensure it will see the final
2715 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002716 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002717 * should have a positive priority.
2718 * Negative priorities are reserved for the system for this broadcast;
2719 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002720 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2721 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002722 * <p>Emergency calls cannot be intercepted using this mechanism, and
2723 * other calls cannot be modified to call emergency numbers using this
2724 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002725 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2726 * call to use their own service instead. Those apps should first prevent
2727 * the call from being placed by setting resultData to <code>null</code>
2728 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002729 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002730 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2731 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002732 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002733 * <p class="note">This is a protected intent that can only be sent
2734 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002735 */
2736 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2737 public static final String ACTION_NEW_OUTGOING_CALL =
2738 "android.intent.action.NEW_OUTGOING_CALL";
2739
2740 /**
2741 * Broadcast Action: Have the device reboot. This is only for use by
2742 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002743 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002744 * <p class="note">This is a protected intent that can only be sent
2745 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002746 */
2747 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2748 public static final String ACTION_REBOOT =
2749 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002750
Wei Huang97ecc9c2009-05-11 17:44:20 -07002751 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002752 * Broadcast Action: A sticky broadcast for changes in the physical
2753 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002754 *
2755 * <p>The intent will have the following extra values:
2756 * <ul>
2757 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002758 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002759 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002760 * <p>This is intended for monitoring the current physical dock state.
2761 * See {@link android.app.UiModeManager} for the normal API dealing with
2762 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002763 */
2764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2765 public static final String ACTION_DOCK_EVENT =
2766 "android.intent.action.DOCK_EVENT";
2767
2768 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002769 * Broadcast Action: A broadcast when idle maintenance can be started.
2770 * This means that the user is not interacting with the device and is
2771 * not expected to do so soon. Typical use of the idle maintenance is
2772 * to perform somehow expensive tasks that can be postponed at a moment
2773 * when they will not degrade user experience.
2774 * <p>
2775 * <p class="note">In order to keep the device responsive in case of an
2776 * unexpected user interaction, implementations of a maintenance task
2777 * should be interruptible. In such a scenario a broadcast with action
2778 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2779 * should not do the maintenance work in
2780 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2781 * maintenance service by {@link Context#startService(Intent)}. Also
2782 * you should hold a wake lock while your maintenance service is running
2783 * to prevent the device going to sleep.
2784 * </p>
2785 * <p>
2786 * <p class="note">This is a protected intent that can only be sent by
2787 * the system.
2788 * </p>
2789 *
2790 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002791 *
2792 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002793 */
2794 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2795 public static final String ACTION_IDLE_MAINTENANCE_START =
2796 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2797
2798 /**
2799 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2800 * This means that the user was not interacting with the device as a result
2801 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2802 * was sent and now the user started interacting with the device. Typical
2803 * use of the idle maintenance is to perform somehow expensive tasks that
2804 * can be postponed at a moment when they will not degrade user experience.
2805 * <p>
2806 * <p class="note">In order to keep the device responsive in case of an
2807 * unexpected user interaction, implementations of a maintenance task
2808 * should be interruptible. Hence, on receiving a broadcast with this
2809 * action, the maintenance task should be interrupted as soon as possible.
2810 * In other words, you should not do the maintenance work in
2811 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2812 * maintenance service that was started on receiving of
2813 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2814 * lock you acquired when your maintenance service started.
2815 * </p>
2816 * <p class="note">This is a protected intent that can only be sent
2817 * by the system.
2818 *
2819 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002820 *
2821 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002822 */
2823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2824 public static final String ACTION_IDLE_MAINTENANCE_END =
2825 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2826
2827 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002828 * Broadcast Action: a remote intent is to be broadcasted.
2829 *
2830 * A remote intent is used for remote RPC between devices. The remote intent
2831 * is serialized and sent from one device to another device. The receiving
2832 * device parses the remote intent and broadcasts it. Note that anyone can
2833 * broadcast a remote intent. However, if the intent receiver of the remote intent
2834 * does not trust intent broadcasts from arbitrary intent senders, it should require
2835 * the sender to hold certain permissions so only trusted sender's broadcast will be
2836 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002837 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002838 */
2839 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002840 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002841
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002842 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002843 * Broadcast Action: This is broadcast once when the user is booting after a
2844 * system update. It can be used to perform cleanup or upgrades after a
2845 * system update.
2846 * <p>
2847 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2848 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2849 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2850 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002851 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002852 * @hide
2853 */
2854 public static final String ACTION_PRE_BOOT_COMPLETED =
2855 "android.intent.action.PRE_BOOT_COMPLETED";
2856
Amith Yamasani13593602012-03-22 16:16:17 -07002857 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002858 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002859 * on restricted users. The broadcast intent contains an extra
2860 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2861 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2862 * String[] depending on the restriction type.<p/>
2863 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002864 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2865 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2866 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002867 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2868 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002869 * @see RestrictionEntry
2870 */
2871 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2872 "android.intent.action.GET_RESTRICTION_ENTRIES";
2873
2874 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002875 * Sent the first time a user is starting, to allow system apps to
2876 * perform one time initialization. (This will not be seen by third
2877 * party applications because a newly initialized user does not have any
2878 * third party applications installed for it.) This is sent early in
2879 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002880 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2881 * broadcast, since it is part of a visible user interaction; be as quick
2882 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002883 */
2884 public static final String ACTION_USER_INITIALIZE =
2885 "android.intent.action.USER_INITIALIZE";
2886
2887 /**
2888 * Sent when a user switch is happening, causing the process's user to be
2889 * brought to the foreground. This is only sent to receivers registered
2890 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2891 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002892 * foreground. This is sent as a foreground
2893 * broadcast, since it is part of a visible user interaction; be as quick
2894 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002895 */
2896 public static final String ACTION_USER_FOREGROUND =
2897 "android.intent.action.USER_FOREGROUND";
2898
2899 /**
2900 * Sent when a user switch is happening, causing the process's user to be
2901 * sent to the background. This is only sent to receivers registered
2902 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2903 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002904 * background. This is sent as a foreground
2905 * broadcast, since it is part of a visible user interaction; be as quick
2906 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002907 */
2908 public static final String ACTION_USER_BACKGROUND =
2909 "android.intent.action.USER_BACKGROUND";
2910
2911 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002912 * Broadcast sent to the system when a user is added. Carries an extra
2913 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2914 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002915 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002916 * @hide
2917 */
2918 public static final String ACTION_USER_ADDED =
2919 "android.intent.action.USER_ADDED";
2920
2921 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002922 * Broadcast sent by the system when a user is started. Carries an extra
2923 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002924 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002925 * that has been started. This is sent as a foreground
2926 * broadcast, since it is part of a visible user interaction; be as quick
2927 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002928 * @hide
2929 */
2930 public static final String ACTION_USER_STARTED =
2931 "android.intent.action.USER_STARTED";
2932
2933 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002934 * Broadcast sent when a user is in the process of starting. Carries an extra
2935 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2936 * sent to registered receivers, not manifest receivers. It is sent to all
2937 * users (including the one that is being started). You must hold
2938 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2939 * this broadcast. This is sent as a background broadcast, since
2940 * its result is not part of the primary UX flow; to safely keep track of
2941 * started/stopped state of a user you can use this in conjunction with
2942 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2943 * other user state broadcasts since those are foreground broadcasts so can
2944 * execute in a different order.
2945 * @hide
2946 */
2947 public static final String ACTION_USER_STARTING =
2948 "android.intent.action.USER_STARTING";
2949
2950 /**
2951 * Broadcast sent when a user is going to be stopped. Carries an extra
2952 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2953 * sent to registered receivers, not manifest receivers. It is sent to all
2954 * users (including the one that is being stopped). You must hold
2955 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2956 * this broadcast. The user will not stop until all receivers have
2957 * handled the broadcast. This is sent as a background broadcast, since
2958 * its result is not part of the primary UX flow; to safely keep track of
2959 * started/stopped state of a user you can use this in conjunction with
2960 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2961 * other user state broadcasts since those are foreground broadcasts so can
2962 * execute in a different order.
2963 * @hide
2964 */
2965 public static final String ACTION_USER_STOPPING =
2966 "android.intent.action.USER_STOPPING";
2967
2968 /**
2969 * Broadcast sent to the system when a user is stopped. Carries an extra
2970 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2971 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2972 * specific package. This is only sent to registered receivers, not manifest
2973 * receivers. It is sent to all running users <em>except</em> the one that
2974 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002975 * @hide
2976 */
2977 public static final String ACTION_USER_STOPPED =
2978 "android.intent.action.USER_STOPPED";
2979
2980 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002981 * 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 -07002982 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002983 * one that has been removed. The user will not be completely removed until all receivers have
2984 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002985 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002986 * @hide
2987 */
2988 public static final String ACTION_USER_REMOVED =
2989 "android.intent.action.USER_REMOVED";
2990
2991 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002992 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002993 * the userHandle of the user to become the current one. This is only sent to
2994 * registered receivers, not manifest receivers. It is sent to all running users.
2995 * You must hold
2996 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002997 * @hide
2998 */
2999 public static final String ACTION_USER_SWITCHED =
3000 "android.intent.action.USER_SWITCHED";
3001
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003002 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003003 * Broadcast Action: Sent when the credential-encrypted private storage has
3004 * become unlocked for the target user. This is only sent to registered
3005 * receivers, not manifest receivers.
3006 */
3007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3008 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3009
3010 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003011 * Broadcast sent to the system when a user's information changes. Carries an extra
3012 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003013 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003014 * @hide
3015 */
3016 public static final String ACTION_USER_INFO_CHANGED =
3017 "android.intent.action.USER_INFO_CHANGED";
3018
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003019 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003020 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3021 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003022 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3023 * that need to display merged content across both primary and managed profiles need to
3024 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003025 * not manifest receivers.
3026 */
3027 public static final String ACTION_MANAGED_PROFILE_ADDED =
3028 "android.intent.action.MANAGED_PROFILE_ADDED";
3029
3030 /**
3031 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003032 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3033 * Only applications (for example Launchers) that need to display merged content across both
3034 * primary and managed profiles need to worry about this broadcast. This is only sent to
3035 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003036 */
3037 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3038 "android.intent.action.MANAGED_PROFILE_REMOVED";
3039
3040 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003041 * Broadcast sent to the primary user when the credential-encrypted private storage for
3042 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3043 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3044 * Launchers) that need to display merged content across both primary and managed profiles
3045 * need to worry about this broadcast. This is only sent to registered receivers,
3046 * not manifest receivers.
3047 */
3048 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3049 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3050
3051 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003052 * Broadcast sent to the primary user when an associated managed profile has become available.
3053 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003054 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3055 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3056 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003057 */
Rubin Xue95057a2016-04-01 16:49:25 +01003058 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3059 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3060
3061 /**
3062 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3063 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3064 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3065 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3066 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3067 */
3068 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3069 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003070
3071 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003072 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3073 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3074 * the device was locked or unlocked.
3075 *
3076 * This is only sent to registered receivers.
3077 *
3078 * @hide
3079 */
3080 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3081 "android.intent.action.DEVICE_LOCKED_CHANGED";
3082
3083 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003084 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3085 */
3086 public static final String ACTION_QUICK_CLOCK =
3087 "android.intent.action.QUICK_CLOCK";
3088
Michael Wright0087a142013-02-05 16:29:39 -08003089 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003090 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003091 * @hide
3092 */
3093 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3094 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3095
Justin Kohd378ad72013-04-01 12:18:26 -07003096 /**
3097 * Broadcast Action: A global button was pressed. Includes a single
3098 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3099 * caused the broadcast.
3100 * @hide
3101 */
3102 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3103
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003104 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003105 * Broadcast Action: Sent when media resource is granted.
3106 * <p>
3107 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3108 * granted.
3109 * </p>
3110 * <p class="note">
3111 * This is a protected intent that can only be sent by the system.
3112 * </p>
3113 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003114 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003115 * </p>
3116 *
3117 * @hide
3118 */
3119 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3120 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3121
3122 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003123 * Activity Action: Allow the user to select and return one or more existing
3124 * documents. When invoked, the system will display the various
3125 * {@link DocumentsProvider} instances installed on the device, letting the
3126 * user interactively navigate through them. These documents include local
3127 * media, such as photos and video, and documents provided by installed
3128 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003129 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003130 * Each document is represented as a {@code content://} URI backed by a
3131 * {@link DocumentsProvider}, which can be opened as a stream with
3132 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3133 * {@link android.provider.DocumentsContract.Document} metadata.
3134 * <p>
3135 * All selected documents are returned to the calling application with
3136 * persistable read and write permission grants. If you want to maintain
3137 * access to the documents across device reboots, you need to explicitly
3138 * take the persistable permissions using
3139 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3140 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003141 * Callers must indicate the acceptable document MIME types through
3142 * {@link #setType(String)}. For example, to select photos, use
3143 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3144 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3145 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003146 * <p>
3147 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003148 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3149 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003150 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003151 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3152 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003153 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003154 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003155 * Callers can set a document URI through
3156 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3157 * location of documents navigator. System will do its best to launch the
3158 * navigator in the specified document if it's a folder, or the folder that
3159 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003160 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003161 * Output: The URI of the item that was picked, returned in
3162 * {@link #getData()}. This must be a {@code content://} URI so that any
3163 * receiver can access it. If multiple documents were selected, they are
3164 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003165 *
3166 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003167 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003168 * @see #ACTION_CREATE_DOCUMENT
3169 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003170 */
3171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3172 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3173
3174 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003175 * Activity Action: Allow the user to create a new document. When invoked,
3176 * the system will display the various {@link DocumentsProvider} instances
3177 * installed on the device, letting the user navigate through them. The
3178 * returned document may be a newly created document with no content, or it
3179 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003180 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003181 * Each document is represented as a {@code content://} URI backed by a
3182 * {@link DocumentsProvider}, which can be opened as a stream with
3183 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3184 * {@link android.provider.DocumentsContract.Document} metadata.
3185 * <p>
3186 * Callers must indicate the concrete MIME type of the document being
3187 * created by setting {@link #setType(String)}. This MIME type cannot be
3188 * changed after the document is created.
3189 * <p>
3190 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3191 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003192 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003193 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3194 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003195 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003196 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003197 * Callers can set a document URI through
3198 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3199 * location of documents navigator. System will do its best to launch the
3200 * navigator in the specified document if it's a folder, or the folder that
3201 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003202 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003203 * Output: The URI of the item that was created. This must be a
3204 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003205 *
3206 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003207 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003208 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003209 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003210 */
3211 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3212 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3213
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003214 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003215 * Activity Action: Allow the user to pick a directory subtree. When
3216 * invoked, the system will display the various {@link DocumentsProvider}
3217 * instances installed on the device, letting the user navigate through
3218 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003219 * <p>
3220 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003221 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3222 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3223 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003224 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003225 * Callers can set a document URI through
3226 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3227 * location of documents navigator. System will do its best to launch the
3228 * navigator in the specified document if it's a folder, or the folder that
3229 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003230 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003231 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003232 *
3233 * @see DocumentsContract
3234 */
3235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003236 public static final String
3237 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003238
Felipe Lemec7b1f892016-01-15 15:02:31 -08003239 /**
Peng Xua35b5532016-01-20 00:05:45 -08003240 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3241 * exisiting sensor being disconnected.
3242 *
3243 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3244 *
3245 * {@hide}
3246 */
3247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3248 public static final String
3249 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3250
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003251 /**
3252 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3253 *
3254 * {@hide}
3255 */
3256 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003257 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3258
Christopher Tate6597e342015-02-17 12:15:25 -08003259 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003260 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3261 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3262 *
3263 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3264 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003265 * @hide
3266 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003267 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003268 public static final String EXTRA_FORCE_MASTER_CLEAR =
3269 "android.intent.extra.FORCE_MASTER_CLEAR";
3270
3271 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003272 * A broadcast action to trigger a factory reset.
3273 *
3274 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3275 *
3276 * <p>Not for use by third-party applications.
3277 *
3278 * @see #EXTRA_FORCE_MASTER_CLEAR
3279 *
3280 * {@hide}
3281 */
3282 @SystemApi
3283 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3284 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3285
3286 /**
3287 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3288 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3289 *
3290 * <p>Not for use by third-party applications.
3291 *
3292 * @hide
3293 */
3294 @SystemApi
3295 public static final String EXTRA_FORCE_FACTORY_RESET =
3296 "android.intent.extra.FORCE_FACTORY_RESET";
3297
3298 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003299 * Broadcast action: report that a settings element is being restored from backup. The intent
3300 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3301 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3302 * is the value of that settings entry prior to the restore operation. All of these values are
3303 * represented as strings.
3304 *
3305 * <p>This broadcast is sent only for settings provider entries known to require special handling
3306 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3307 * the provider's backup agent implementation.
3308 *
3309 * @see #EXTRA_SETTING_NAME
3310 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3311 * @see #EXTRA_SETTING_NEW_VALUE
3312 * {@hide}
3313 */
3314 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3315
3316 /** {@hide} */
3317 public static final String EXTRA_SETTING_NAME = "setting_name";
3318 /** {@hide} */
3319 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3320 /** {@hide} */
3321 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3322
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003323 /**
3324 * Activity Action: Process a piece of text.
3325 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3326 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3327 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3328 */
3329 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3330 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3331 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003332 * The name of the extra used to define the text to be processed, as a
3333 * CharSequence. Note that this may be a styled CharSequence, so you must use
3334 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003335 */
3336 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3337 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003338 * 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 +00003339 */
3340 public static final String EXTRA_PROCESS_TEXT_READONLY =
3341 "android.intent.extra.PROCESS_TEXT_READONLY";
3342
Bryce Leebc58f592015-09-25 16:43:01 -07003343 /**
3344 * Broadcast action: reports when a new thermal event has been reached. When the device
3345 * is reaching its maximum temperatue, the thermal level reported
3346 * {@hide}
3347 */
3348 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3349 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3350
3351 /** {@hide} */
3352 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3353
3354 /**
3355 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003356 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003357 * {@hide}
3358 */
3359 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3360
3361 /**
3362 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003363 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003364 * {@hide}
3365 */
3366 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3367
3368 /**
3369 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003370 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003371 * {@hide}
3372 */
3373 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3374
3375
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003376 // ---------------------------------------------------------------------
3377 // ---------------------------------------------------------------------
3378 // Standard intent categories (see addCategory()).
3379
3380 /**
3381 * Set if the activity should be an option for the default action
3382 * (center press) to perform on a piece of data. Setting this will
3383 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003384 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003385 * Intent when initiating an action -- it is for use in intent filters
3386 * specified in packages.
3387 */
3388 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3389 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3390 /**
3391 * Activities that can be safely invoked from a browser must support this
3392 * category. For example, if the user is viewing a web page or an e-mail
3393 * and clicks on a link in the text, the Intent generated execute that
3394 * link will require the BROWSABLE category, so that only activities
3395 * supporting this category will be considered as possible actions. By
3396 * supporting this category, you are promising that there is nothing
3397 * damaging (without user intervention) that can happen by invoking any
3398 * matching Intent.
3399 */
3400 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3401 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3402 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003403 * Categories for activities that can participate in voice interaction.
3404 * An activity that supports this category must be prepared to run with
3405 * no UI shown at all (though in some case it may have a UI shown), and
3406 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3407 */
3408 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3409 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3410 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003411 * Set if the activity should be considered as an alternative action to
3412 * the data the user is currently viewing. See also
3413 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3414 * applies to the selection in a list of items.
3415 *
3416 * <p>Supporting this category means that you would like your activity to be
3417 * displayed in the set of alternative things the user can do, usually as
3418 * part of the current activity's options menu. You will usually want to
3419 * include a specific label in the &lt;intent-filter&gt; of this action
3420 * describing to the user what it does.
3421 *
3422 * <p>The action of IntentFilter with this category is important in that it
3423 * describes the specific action the target will perform. This generally
3424 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3425 * a specific name such as "com.android.camera.action.CROP. Only one
3426 * alternative of any particular action will be shown to the user, so using
3427 * a specific action like this makes sure that your alternative will be
3428 * displayed while also allowing other applications to provide their own
3429 * overrides of that particular action.
3430 */
3431 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3432 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3433 /**
3434 * Set if the activity should be considered as an alternative selection
3435 * action to the data the user has currently selected. This is like
3436 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3437 * of items from which the user can select, giving them alternatives to the
3438 * default action that will be performed on it.
3439 */
3440 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3441 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3442 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003443 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003444 */
3445 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3446 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3447 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003448 * Should be displayed in the top-level launcher.
3449 */
3450 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3451 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3452 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003453 * Indicates an activity optimized for Leanback mode, and that should
3454 * be displayed in the Leanback launcher.
3455 */
3456 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3457 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3458 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003459 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3460 * @hide
3461 */
3462 @SystemApi
3463 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3464 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003465 * Provides information about the package it is in; typically used if
3466 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3467 * a front-door to the user without having to be shown in the all apps list.
3468 */
3469 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3470 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3471 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003472 * This is the home activity, that is the first activity that is displayed
3473 * when the device boots.
3474 */
3475 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3476 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3477 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003478 * This is the home activity that is displayed when the device is finished setting up and ready
3479 * for use.
3480 * @hide
3481 */
3482 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3483 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3484 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003485 * This is the setup wizard activity, that is the first activity that is displayed
3486 * when the user sets up the device for the first time.
3487 * @hide
3488 */
3489 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3490 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3491 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003492 * This activity is a preference panel.
3493 */
3494 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3495 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3496 /**
3497 * This activity is a development preference panel.
3498 */
3499 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3500 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3501 /**
3502 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003503 */
3504 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3505 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3506 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003507 * This activity allows the user to browse and download new applications.
3508 */
3509 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3510 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3511 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003512 * This activity may be exercised by the monkey or other automated test tools.
3513 */
3514 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3515 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3516 /**
3517 * To be used as a test (not part of the normal user experience).
3518 */
3519 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3520 /**
3521 * To be used as a unit test (run through the Test Harness).
3522 */
3523 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3524 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003525 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003526 * experience).
3527 */
3528 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003529
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003530 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003531 * Used to indicate that an intent only wants URIs that can be opened with
3532 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3533 * must support at least the columns defined in {@link OpenableColumns} when
3534 * queried.
3535 *
3536 * @see #ACTION_GET_CONTENT
3537 * @see #ACTION_OPEN_DOCUMENT
3538 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003539 */
3540 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3541 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3542
3543 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003544 * Used to indicate that an intent filter can accept files which are not necessarily
3545 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3546 * at least streamable via
3547 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3548 * using one of the stream types exposed via
3549 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3550 *
3551 * @see #ACTION_SEND
3552 * @see #ACTION_SEND_MULTIPLE
3553 */
3554 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3555 public static final String CATEGORY_TYPED_OPENABLE =
3556 "android.intent.category.TYPED_OPENABLE";
3557
3558 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003559 * To be used as code under test for framework instrumentation tests.
3560 */
3561 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3562 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003563 /**
3564 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003565 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3566 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003567 */
3568 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3569 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3570 /**
3571 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003572 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3573 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003574 */
3575 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3576 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003577 /**
3578 * An activity to run when device is inserted into a analog (low end) dock.
3579 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3580 * information, see {@link android.app.UiModeManager}.
3581 */
3582 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3583 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3584
3585 /**
3586 * An activity to run when device is inserted into a digital (high end) dock.
3587 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3588 * information, see {@link android.app.UiModeManager}.
3589 */
3590 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3591 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003592
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003593 /**
3594 * Used to indicate that the activity can be used in a car environment.
3595 */
3596 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3597 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3598
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003599 // ---------------------------------------------------------------------
3600 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003601 // Application launch intent categories (see addCategory()).
3602
3603 /**
3604 * Used with {@link #ACTION_MAIN} to launch the browser application.
3605 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003606 * <p>NOTE: This should not be used as the primary key of an Intent,
3607 * since it will not result in the app launching with the correct
3608 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003609 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003610 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003611 */
3612 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3613 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3614
3615 /**
3616 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3617 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003618 * <p>NOTE: This should not be used as the primary key of an Intent,
3619 * since it will not result in the app launching with the correct
3620 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003621 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003622 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003623 */
3624 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3625 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3626
3627 /**
3628 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3629 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003630 * <p>NOTE: This should not be used as the primary key of an Intent,
3631 * since it will not result in the app launching with the correct
3632 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003633 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003634 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003635 */
3636 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3637 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3638
3639 /**
3640 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3641 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003642 * <p>NOTE: This should not be used as the primary key of an Intent,
3643 * since it will not result in the app launching with the correct
3644 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003645 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003646 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003647 */
3648 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3649 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3650
3651 /**
3652 * Used with {@link #ACTION_MAIN} to launch the email application.
3653 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003654 * <p>NOTE: This should not be used as the primary key of an Intent,
3655 * since it will not result in the app launching with the correct
3656 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003657 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003658 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003659 */
3660 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3661 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3662
3663 /**
3664 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3665 * The activity should be able to view and manipulate image and video files
3666 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003667 * <p>NOTE: This should not be used as the primary key of an Intent,
3668 * since it will not result in the app launching with the correct
3669 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003670 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003671 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003672 */
3673 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3674 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3675
3676 /**
3677 * Used with {@link #ACTION_MAIN} to launch the maps application.
3678 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003679 * <p>NOTE: This should not be used as the primary key of an Intent,
3680 * since it will not result in the app launching with the correct
3681 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003682 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003683 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003684 */
3685 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3686 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3687
3688 /**
3689 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3690 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003691 * <p>NOTE: This should not be used as the primary key of an Intent,
3692 * since it will not result in the app launching with the correct
3693 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003694 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003695 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003696 */
3697 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3698 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3699
3700 /**
3701 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003702 * The activity should be able to play, browse, or manipulate music files
3703 * stored on the device.
3704 * <p>NOTE: This should not be used as the primary key of an Intent,
3705 * since it will not result in the app launching with the correct
3706 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003707 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003708 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003709 */
3710 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3711 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3712
3713 // ---------------------------------------------------------------------
3714 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003715 // Standard extra data keys.
3716
3717 /**
3718 * The initial data to place in a newly created record. Use with
3719 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3720 * fields as would be given to the underlying ContentProvider.insert()
3721 * call.
3722 */
3723 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3724
3725 /**
3726 * A constant CharSequence that is associated with the Intent, used with
3727 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3728 * this may be a styled CharSequence, so you must use
3729 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3730 * retrieve it.
3731 */
3732 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3733
3734 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003735 * A constant String that is associated with the Intent, used with
3736 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3737 * as HTML formatted text. Note that you <em>must</em> also supply
3738 * {@link #EXTRA_TEXT}.
3739 */
3740 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3741
3742 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003743 * A content: URI holding a stream of data associated with the Intent,
3744 * used with {@link #ACTION_SEND} to supply the data being sent.
3745 */
3746 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3747
3748 /**
3749 * A String[] holding e-mail addresses that should be delivered to.
3750 */
3751 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3752
3753 /**
3754 * A String[] holding e-mail addresses that should be carbon copied.
3755 */
3756 public static final String EXTRA_CC = "android.intent.extra.CC";
3757
3758 /**
3759 * A String[] holding e-mail addresses that should be blind carbon copied.
3760 */
3761 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3762
3763 /**
3764 * A constant string holding the desired subject line of a message.
3765 */
3766 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3767
3768 /**
3769 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003770 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003771 */
3772 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3773
3774 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003775 * An int representing the user id to be used.
3776 *
3777 * @hide
3778 */
3779 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3780
3781 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003782 * An int representing the task id to be retrieved. This is used when a launch from recents is
3783 * intercepted by another action such as credentials confirmation to remember which task should
3784 * be resumed when complete.
3785 *
3786 * @hide
3787 */
3788 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3789
3790 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003791 * An Intent[] describing additional, alternate choices you would like shown with
3792 * {@link #ACTION_CHOOSER}.
3793 *
3794 * <p>An app may be capable of providing several different payload types to complete a
3795 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3796 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3797 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3798 * photo data or a hosted link where the photos can be viewed.</p>
3799 *
3800 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3801 * first/primary/preferred intent in the set. Additional intents specified in
3802 * this extra are ordered; by default intents that appear earlier in the array will be
3803 * preferred over intents that appear later in the array as matches for the same
3804 * target component. To alter this preference, a calling app may also supply
3805 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3806 */
3807 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3808
3809 /**
Adam Powell52c39212016-04-07 15:14:18 -07003810 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3811 * and omitted from a list of components presented to the user.
3812 *
3813 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3814 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3815 * from your own package or other apps from your organization if the idea of sending to those
3816 * targets would be redundant with other app functionality. Filtered components will not
3817 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3818 */
3819 public static final String EXTRA_EXCLUDE_COMPONENTS
3820 = "android.intent.extra.EXCLUDE_COMPONENTS";
3821
3822 /**
3823 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3824 * describing additional high-priority deep-link targets for the chooser to present to the user.
3825 *
3826 * <p>Targets provided in this way will be presented inline with all other targets provided
3827 * by services from other apps. They will be prioritized before other service targets, but
3828 * after those targets provided by sources that the user has manually pinned to the front.</p>
3829 *
3830 * @see #ACTION_CHOOSER
3831 */
3832 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3833
3834 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003835 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3836 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3837 *
3838 * <p>An app preparing an action for another app to complete may wish to allow the user to
3839 * disambiguate between several options for completing the action based on the chosen target
3840 * or otherwise refine the action before it is invoked.
3841 * </p>
3842 *
3843 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3844 * <ul>
3845 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3846 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3847 * chosen target beyond the first</li>
3848 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3849 * should fill in and send once the disambiguation is complete</li>
3850 * </ul>
3851 */
3852 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3853 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3854
3855 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08003856 * An {@code ArrayList} of {@code String} annotations describing content for
3857 * {@link #ACTION_CHOOSER}.
3858 *
3859 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
3860 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
3861 *
3862 * <p>Annotations should describe the major components or topics of the content. It is up to
3863 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
3864 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
3865 * start {@link #ACTION_CHOOSER}. Performance on customized annotations can suffer, if they are
3866 * rarely used for {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to
3867 * use the following annotations when applicable:</p>
3868 * <ul>
3869 * <li>"product": represents that the topic of the content is mainly about products, e.g.,
3870 * health & beauty, and office supplies.</li>
3871 * <li>"emotion": represents that the topic of the content is mainly about emotions, e.g.,
3872 * happy, and sad.</li>
3873 * <li>"person": represents that the topic of the content is mainly about persons, e.g.,
3874 * face, finger, standing, and walking.</li>
3875 * <li>"child": represents that the topic of the content is mainly about children, e.g.,
3876 * child, and baby.</li>
3877 * <li>"selfie": represents that the topic of the content is mainly about selfies.</li>
3878 * <li>"crowd": represents that the topic of the content is mainly about crowds.</li>
3879 * <li>"party": represents that the topic of the content is mainly about parties.</li>
3880 * <li>"animal": represent that the topic of the content is mainly about animals.</li>
3881 * <li>"plant": represents that the topic of the content is mainly about plants, e.g.,
3882 * flowers.</li>
3883 * <li>"vacation": represents that the topic of the content is mainly about vacations.</li>
3884 * <li>"fashion": represents that the topic of the content is mainly about fashion, e.g.
3885 * sunglasses, jewelry, handbags and clothing.</li>
3886 * <li>"material": represents that the topic of the content is mainly about materials, e.g.,
3887 * paper, and silk.</li>
3888 * <li>"vehicle": represents that the topic of the content is mainly about vehicles, like
3889 * cars, and boats.</li>
3890 * <li>"document": represents that the topic of the content is mainly about documents, e.g.
3891 * posters.</li>
3892 * <li>"design": represents that the topic of the content is mainly about design, e.g. arts
3893 * and designs of houses.</li>
3894 * <li>"holiday": represents that the topic of the content is mainly about holidays, e.g.,
3895 * Christmas and Thanksgiving.</li>
3896 * </ul>
3897 */
3898 public static final String EXTRA_CONTENT_ANNOTATIONS
3899 = "android.intent.extra.CONTENT_ANNOTATIONS";
3900
3901 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003902 * A {@link ResultReceiver} used to return data back to the sender.
3903 *
3904 * <p>Used to complete an app-specific
3905 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3906 *
3907 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3908 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3909 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3910 * when the user selects a target component from the chooser. It is up to the recipient
3911 * to send a result to this ResultReceiver to signal that disambiguation is complete
3912 * and that the chooser should invoke the user's choice.</p>
3913 *
3914 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3915 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3916 * to match and fill in the final Intent or ChooserTarget before starting it.
3917 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3918 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3919 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3920 *
3921 * <p>The result code passed to the ResultReceiver should be
3922 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3923 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3924 * the chooser should finish without starting a target.</p>
3925 */
3926 public static final String EXTRA_RESULT_RECEIVER
3927 = "android.intent.extra.RESULT_RECEIVER";
3928
3929 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003930 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003931 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003932 */
3933 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3934
3935 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003936 * A Parcelable[] of {@link Intent} or
3937 * {@link android.content.pm.LabeledIntent} objects as set with
3938 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3939 * a the front of the list of choices, when shown to the user with a
3940 * {@link #ACTION_CHOOSER}.
3941 */
3942 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3943
3944 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003945 * A {@link IntentSender} to start after ephemeral installation success.
3946 * @hide
3947 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003948 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3949
3950 /**
3951 * A {@link IntentSender} to start after ephemeral installation failure.
3952 * @hide
3953 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003954 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3955
3956 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08003957 * The host name that triggered an ephemeral resolution.
3958 * @hide
3959 */
3960 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
3961
3962 /**
3963 * An opaque token to track ephemeral resolution.
3964 * @hide
3965 */
3966 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
3967
3968 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003969 * A Bundle forming a mapping of potential target package names to different extras Bundles
3970 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3971 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3972 * be currently installed on the device.
3973 *
3974 * <p>An application may choose to provide alternate extras for the case where a user
3975 * selects an activity from a predetermined set of target packages. If the activity
3976 * the user selects from the chooser belongs to a package with its package name as
3977 * a key in this bundle, the corresponding extras for that package will be merged with
3978 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3979 * extra has the same key as an extra already present in the intent it will overwrite
3980 * the extra from the intent.</p>
3981 *
3982 * <p><em>Examples:</em>
3983 * <ul>
3984 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3985 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3986 * parameters for that target.</li>
3987 * <li>An application may offer additional metadata for known targets of a given intent
3988 * to pass along information only relevant to that target such as account or content
3989 * identifiers already known to that application.</li>
3990 * </ul></p>
3991 */
3992 public static final String EXTRA_REPLACEMENT_EXTRAS =
3993 "android.intent.extra.REPLACEMENT_EXTRAS";
3994
3995 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003996 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3997 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3998 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3999 * {@link ComponentName} of the chosen component.
4000 *
4001 * <p>In some situations this callback may never come, for example if the user abandons
4002 * the chooser, switches to another task or any number of other reasons. Apps should not
4003 * be written assuming that this callback will always occur.</p>
4004 */
4005 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4006 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4007
4008 /**
4009 * The {@link ComponentName} chosen by the user to complete an action.
4010 *
4011 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4012 */
4013 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4014
4015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004016 * A {@link android.view.KeyEvent} object containing the event that
4017 * triggered the creation of the Intent it is in.
4018 */
4019 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4020
4021 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004022 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4023 * before shutting down.
4024 *
4025 * {@hide}
4026 */
4027 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4028
4029 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004030 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4031 * requested by the user.
4032 *
4033 * {@hide}
4034 */
4035 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4036 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4037
4038 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004039 * 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 -07004040 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4041 * of restarting the application.
4042 */
4043 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4044
4045 /**
4046 * A String holding the phone number originally entered in
4047 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4048 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4049 */
4050 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004051
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004052 /**
4053 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4054 * intents to supply the uid the package had been assigned. Also an optional
4055 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4056 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4057 * purpose.
4058 */
4059 public static final String EXTRA_UID = "android.intent.extra.UID";
4060
4061 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004062 * @hide String array of package names.
4063 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004064 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004065 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4066
4067 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004068 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4069 * intents to indicate whether this represents a full uninstall (removing
4070 * both the code and its data) or a partial uninstall (leaving its data,
4071 * implying that this is an update).
4072 */
4073 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004074
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004075 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004076 * @hide
4077 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4078 * intents to indicate that at this point the package has been removed for
4079 * all users on the device.
4080 */
4081 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4082 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4083
4084 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004085 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4086 * intents to indicate that this is a replacement of the package, so this
4087 * broadcast will immediately be followed by an add broadcast for a
4088 * different version of the same package.
4089 */
4090 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004091
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004092 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004093 * Used as an int extra field in {@link android.app.AlarmManager} intents
4094 * to tell the application being invoked how many pending alarms are being
4095 * delievered with the intent. For one-shot alarms this will always be 1.
4096 * For recurring alarms, this might be greater than 1 if the device was
4097 * asleep or powered off at the time an earlier alarm would have been
4098 * delivered.
4099 */
4100 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004101
Jacek Surazski86b6c532009-05-13 14:38:28 +02004102 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004103 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4104 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004105 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4106 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004107 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4108 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4109 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004110 */
4111 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4112
4113 /**
4114 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4115 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004116 */
4117 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4118
4119 /**
4120 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4121 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004122 */
4123 public static final int EXTRA_DOCK_STATE_DESK = 1;
4124
4125 /**
4126 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4127 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004128 */
4129 public static final int EXTRA_DOCK_STATE_CAR = 2;
4130
4131 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004132 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4133 * to represent that the phone is in a analog (low end) dock.
4134 */
4135 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4136
4137 /**
4138 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4139 * to represent that the phone is in a digital (high end) dock.
4140 */
4141 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4142
4143 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004144 * Boolean that can be supplied as meta-data with a dock activity, to
4145 * indicate that the dock should take over the home key when it is active.
4146 */
4147 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004148
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004149 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004150 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4151 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004152 */
4153 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4154
4155 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004156 * Used in the extra field in the remote intent. It's astring token passed with the
4157 * remote intent.
4158 */
4159 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4160 "android.intent.extra.remote_intent_token";
4161
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004162 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004163 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004164 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004165 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004166 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004167 "android.intent.extra.changed_component_name";
4168
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004169 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004170 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004171 * and contains a string array of all of the components that have changed. If
4172 * the state of the overall package has changed, then it will contain an entry
4173 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004174 */
4175 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4176 "android.intent.extra.changed_component_name_list";
4177
4178 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004179 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004180 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004181 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4182 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4183 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004184 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004185 */
4186 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4187 "android.intent.extra.changed_package_list";
4188
4189 /**
4190 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004191 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4192 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004193 * and contains an integer array of uids of all of the components
4194 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004195 */
4196 public static final String EXTRA_CHANGED_UID_LIST =
4197 "android.intent.extra.changed_uid_list";
4198
4199 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004200 * @hide
4201 * Magic extra system code can use when binding, to give a label for
4202 * who it is that has bound to a service. This is an integer giving
4203 * a framework string resource that can be displayed to the user.
4204 */
4205 public static final String EXTRA_CLIENT_LABEL =
4206 "android.intent.extra.client_label";
4207
4208 /**
4209 * @hide
4210 * Magic extra system code can use when binding, to give a PendingIntent object
4211 * that can be launched for the user to disable the system's use of this
4212 * service.
4213 */
4214 public static final String EXTRA_CLIENT_INTENT =
4215 "android.intent.extra.client_intent";
4216
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004217 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004218 * Extra used to indicate that an intent should only return data that is on
4219 * the local device. This is a boolean extra; the default is false. If true,
4220 * an implementation should only allow the user to select data that is
4221 * already on the device, not requiring it be downloaded from a remote
4222 * service when opened.
4223 *
4224 * @see #ACTION_GET_CONTENT
4225 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004226 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004227 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004228 */
4229 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004230 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004231
Amith Yamasani13593602012-03-22 16:16:17 -07004232 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004233 * Extra used to indicate that an intent can allow the user to select and
4234 * return multiple items. This is a boolean extra; the default is false. If
4235 * true, an implementation is allowed to present the user with a UI where
4236 * they can pick multiple items that are all returned to the caller. When
4237 * this happens, they should be returned as the {@link #getClipData()} part
4238 * of the result Intent.
4239 *
4240 * @see #ACTION_GET_CONTENT
4241 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004242 */
4243 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004244 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004245
4246 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004247 * The integer userHandle carried with broadcast intents related to addition, removal and
4248 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4249 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4250 *
Amith Yamasani13593602012-03-22 16:16:17 -07004251 * @hide
4252 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004253 public static final String EXTRA_USER_HANDLE =
4254 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004255
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004256 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004257 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4258 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4259 */
4260 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004261 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004262
4263 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004264 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004265 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4266 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004267 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004268 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4269
4270 /**
4271 * Extra sent in the intent to the BroadcastReceiver that handles
4272 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4273 * the restrictions as key/value pairs.
4274 */
4275 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4276 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004277
Amith Yamasani86118ba2013-03-28 14:33:16 -07004278 /**
4279 * Extra used in the response from a BroadcastReceiver that handles
4280 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4281 */
4282 public static final String EXTRA_RESTRICTIONS_INTENT =
4283 "android.intent.extra.restrictions_intent";
4284
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004285 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004286 * Extra used to communicate a set of acceptable MIME types. The type of the
4287 * extra is {@code String[]}. Values may be a combination of concrete MIME
4288 * types (such as "image/png") and/or partial MIME types (such as
4289 * "audio/*").
4290 *
4291 * @see #ACTION_GET_CONTENT
4292 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004293 */
4294 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4295
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004296 /**
4297 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4298 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004299 * When this is true, hardware devices can use this information to determine that
4300 * they shouldn't do a complete shutdown of their device since this is not a
4301 * complete shutdown down to the kernel, but only user space restarting.
4302 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004303 */
4304 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4305 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4306
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004307 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004308 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4309 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4310 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4311 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004312 *
4313 * @hide for internal use only.
4314 */
4315 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4316 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004317 /** @hide */
4318 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4319 /** @hide */
4320 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4321 /** @hide */
4322 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004323
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004324 /** {@hide} */
4325 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4326
Rubin Xue8490f12015-06-25 12:17:48 +01004327 /** {@hide} */
4328 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4329
Santos Cordon15a13782015-03-31 18:32:31 -07004330 /**
4331 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4332 * activation request.
4333 * TODO: Add information about the structure and response data used with the pending intent.
4334 * @hide
4335 */
4336 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4337 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4338
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004339 /**
4340 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004341 *
4342 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004343 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004344 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4345
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004346 /**
4347 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004348 * When a profile goes into quiet mode, all apps in the profile are killed and the
4349 * profile user is stopped. Widgets originating from the profile are masked, and app
4350 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004351 */
4352 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004353
4354 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004355 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004356 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004357 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4358 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004359 *
4360 * @hide
4361 */
4362 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4363 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4364
4365 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004366 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4367 * whether to show the chooser or not when there is only one application available
4368 * to choose from.
4369 *
4370 * @hide
4371 */
4372 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4373 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4374
4375 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004376 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004377 * to represent that a video codec is allowed to use.
4378 *
4379 * @hide
4380 */
4381 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4382
4383 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004384 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004385 * to represent that a audio codec is allowed to use.
4386 *
4387 * @hide
4388 */
4389 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4390
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 // ---------------------------------------------------------------------
4392 // ---------------------------------------------------------------------
4393 // Intent flags (see mFlags variable).
4394
Tor Norbyed9273d62013-05-30 15:59:53 -07004395 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004396 @IntDef(flag = true, value = {
4397 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4398 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004399 @Retention(RetentionPolicy.SOURCE)
4400 public @interface GrantUriMode {}
4401
Jeff Sharkey846318a2014-04-04 12:12:41 -07004402 /** @hide */
4403 @IntDef(flag = true, value = {
4404 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4405 @Retention(RetentionPolicy.SOURCE)
4406 public @interface AccessUriMode {}
4407
4408 /**
4409 * Test if given mode flags specify an access mode, which must be at least
4410 * read and/or write.
4411 *
4412 * @hide
4413 */
4414 public static boolean isAccessUriMode(int modeFlags) {
4415 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4416 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4417 }
4418
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004419 /**
4420 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004421 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004422 * specified in its ClipData. When applying to an Intent's ClipData,
4423 * all URIs as well as recursive traversals through data or other ClipData
4424 * in Intent items will be granted; only the grant flags of the top-level
4425 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004426 */
4427 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4428 /**
4429 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004430 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004431 * specified in its ClipData. When applying to an Intent's ClipData,
4432 * all URIs as well as recursive traversals through data or other ClipData
4433 * in Intent items will be granted; only the grant flags of the top-level
4434 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004435 */
4436 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4437 /**
4438 * Can be set by the caller to indicate that this Intent is coming from
4439 * a background operation, not from direct user interaction.
4440 */
4441 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4442 /**
4443 * A flag you can enable for debugging: when set, log messages will be
4444 * printed during the resolution of this intent to show you what has
4445 * been found to create the final resolved list.
4446 */
4447 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004448 /**
4449 * If set, this intent will not match any components in packages that
4450 * are currently stopped. If this is not set, then the default behavior
4451 * is to include such applications in the result.
4452 */
4453 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4454 /**
4455 * If set, this intent will always match any components in packages that
4456 * are currently stopped. This is the default behavior when
4457 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4458 * flags are set, this one wins (it allows overriding of exclude for
4459 * places where the framework may automatically set the exclude flag).
4460 */
4461 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004462
4463 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004464 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004465 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004466 * persisted across device reboots until explicitly revoked with
4467 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4468 * grant for possible persisting; the receiving application must call
4469 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4470 * actually persist.
4471 *
4472 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4473 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4474 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004475 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004476 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004477 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004478
4479 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004480 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4481 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4482 * applies to any URI that is a prefix match against the original granted
4483 * URI. (Without this flag, the URI must match exactly for access to be
4484 * granted.) Another URI is considered a prefix match only when scheme,
4485 * authority, and all path segments defined by the prefix are an exact
4486 * match.
4487 */
4488 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4489
4490 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004491 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004492 * homework and verified that they correctly handle packages and components
4493 * that come and go over time. In particular:
4494 * <ul>
4495 * <li>Apps installed on external storage, which will appear to be
4496 * uninstalled while the the device is ejected.
4497 * <li>Apps with encryption unaware components, which will appear to not
4498 * exist while the device is locked.
4499 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004500 *
4501 * @hide
4502 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004503 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004504
4505 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004506 * Internal flag used to indicate ephemeral applications should not be
4507 * considered when resolving the intent.
4508 *
4509 * @hide
4510 */
4511 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4512
4513 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004514 * If set, the new activity is not kept in the history stack. As soon as
4515 * the user navigates away from it, the activity is finished. This may also
4516 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4517 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004518 *
4519 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4520 * is never invoked when the current activity starts a new activity which
4521 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004522 */
4523 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4524 /**
4525 * If set, the activity will not be launched if it is already running
4526 * at the top of the history stack.
4527 */
4528 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4529 /**
4530 * If set, this activity will become the start of a new task on this
4531 * history stack. A task (from the activity that started it to the
4532 * next task activity) defines an atomic group of activities that the
4533 * user can move to. Tasks can be moved to the foreground and background;
4534 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004535 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004536 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4537 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004538 *
4539 * <p>This flag is generally used by activities that want
4540 * to present a "launcher" style behavior: they give the user a list of
4541 * separate things that can be done, which otherwise run completely
4542 * independently of the activity launching them.
4543 *
4544 * <p>When using this flag, if a task is already running for the activity
4545 * you are now starting, then a new activity will not be started; instead,
4546 * the current task will simply be brought to the front of the screen with
4547 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4548 * to disable this behavior.
4549 *
4550 * <p>This flag can not be used when the caller is requesting a result from
4551 * the activity being launched.
4552 */
4553 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4554 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004555 * This flag is used to create a new task and launch an activity into it.
4556 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4557 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4558 * search through existing tasks for ones matching this Intent. Only if no such
4559 * task is found would a new task be created. When paired with
4560 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4561 * the search for a matching task and unconditionally start a new task.
4562 *
4563 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4564 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004565 * top-level application launcher.</strong> Used in conjunction with
4566 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4567 * behavior of bringing an existing task to the foreground. When set,
4568 * a new task is <em>always</em> started to host the Activity for the
4569 * Intent, regardless of whether there is already an existing task running
4570 * the same thing.
4571 *
4572 * <p><strong>Because the default system does not include graphical task management,
4573 * you should not use this flag unless you provide some way for a user to
4574 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004575 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004576 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4577 * creating new document tasks.
4578 *
4579 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004580 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004581 *
Scott Main7aee61f2011-02-08 11:25:01 -08004582 * <p>See
4583 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4584 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004585 *
4586 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4587 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004588 */
4589 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4590 /**
4591 * If set, and the activity being launched is already running in the
4592 * current task, then instead of launching a new instance of that activity,
4593 * all of the other activities on top of it will be closed and this Intent
4594 * will be delivered to the (now on top) old activity as a new Intent.
4595 *
4596 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4597 * If D calls startActivity() with an Intent that resolves to the component
4598 * of activity B, then C and D will be finished and B receive the given
4599 * Intent, resulting in the stack now being: A, B.
4600 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004601 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004602 * either receive the new intent you are starting here in its
4603 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004604 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004605 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4606 * the same intent, then it will be finished and re-created; for all other
4607 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4608 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004609 *
4610 * <p>This launch mode can also be used to good effect in conjunction with
4611 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4612 * of a task, it will bring any currently running instance of that task
4613 * to the foreground, and then clear it to its root state. This is
4614 * especially useful, for example, when launching an activity from the
4615 * notification manager.
4616 *
Scott Main7aee61f2011-02-08 11:25:01 -08004617 * <p>See
4618 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4619 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004620 */
4621 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4622 /**
4623 * If set and this intent is being used to launch a new activity from an
4624 * existing one, then the reply target of the existing activity will be
4625 * transfered to the new activity. This way the new activity can call
4626 * {@link android.app.Activity#setResult} and have that result sent back to
4627 * the reply target of the original activity.
4628 */
4629 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4630 /**
4631 * If set and this intent is being used to launch a new activity from an
4632 * existing one, the current activity will not be counted as the top
4633 * activity for deciding whether the new intent should be delivered to
4634 * the top instead of starting a new one. The previous activity will
4635 * be used as the top, with the assumption being that the current activity
4636 * will finish itself immediately.
4637 */
4638 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4639 /**
4640 * If set, the new activity is not kept in the list of recently launched
4641 * activities.
4642 */
4643 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4644 /**
4645 * This flag is not normally set by application code, but set for you by
4646 * the system as described in the
4647 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4648 * launchMode} documentation for the singleTask mode.
4649 */
4650 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4651 /**
4652 * If set, and this activity is either being started in a new task or
4653 * bringing to the top an existing task, then it will be launched as
4654 * the front door of the task. This will result in the application of
4655 * any affinities needed to have that task in the proper state (either
4656 * moving activities to or from it), or simply resetting that task to
4657 * its initial state if needed.
4658 */
4659 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4660 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004661 * This flag is not normally set by application code, but set for you by
4662 * the system if this activity is being launched from history
4663 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004664 */
4665 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004666 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004667 * @deprecated As of API 21 this performs identically to
4668 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004669 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004670 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004671 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004672 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004673 * This flag is used to open a document into a new task rooted at the activity launched
4674 * by this Intent. Through the use of this flag, or its equivalent attribute,
4675 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004676 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004677 *
Craig Mautner026596b2014-05-21 15:35:44 -07004678 * <p>The use of the activity attribute form of this,
4679 * {@link android.R.attr#documentLaunchMode}, is
4680 * preferred over the Intent flag described here. The attribute form allows the
4681 * Activity to specify multiple document behavior for all launchers of the Activity
4682 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004683 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004684 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4685 * it is kept after the activity is finished is different than the use of
4686 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4687 * this flag is being used to create a new recents entry, then by default that entry
4688 * will be removed once the activity is finished. You can modify this behavior with
4689 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4690 *
Craig Mautner026596b2014-05-21 15:35:44 -07004691 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4692 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4693 * equivalent of the Activity manifest specifying {@link
4694 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4695 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4696 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004697 *
Craig Mautner026596b2014-05-21 15:35:44 -07004698 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004699 *
Craig Mautner026596b2014-05-21 15:35:44 -07004700 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004701 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4702 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004703 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004704 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004705 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004706 * callback from occurring on the current frontmost activity before it is
4707 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004708 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004709 * <p>Typically, an activity can rely on that callback to indicate that an
4710 * explicit user action has caused their activity to be moved out of the
4711 * foreground. The callback marks an appropriate point in the activity's
4712 * lifecycle for it to dismiss any notifications that it intends to display
4713 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004714 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004715 * <p>If an activity is ever started via any non-user-driven events such as
4716 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4717 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004718 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004719 */
4720 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004721 /**
4722 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4723 * this flag will cause the launched activity to be brought to the front of its
4724 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004725 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004726 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4727 * If D calls startActivity() with an Intent that resolves to the component
4728 * of activity B, then B will be brought to the front of the history stack,
4729 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004730 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004731 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004732 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004733 */
4734 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004735 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004736 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4737 * this flag will prevent the system from applying an activity transition
4738 * animation to go to the next activity state. This doesn't mean an
4739 * animation will never run -- if another activity change happens that doesn't
4740 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004741 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004742 * when you are going to do a series of activity operations but the
4743 * animation seen by the user shouldn't be driven by the first activity
4744 * change but rather a later one.
4745 */
4746 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4747 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004748 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4749 * this flag will cause any existing task that would be associated with the
4750 * activity to be cleared before the activity is started. That is, the activity
4751 * becomes the new root of an otherwise empty task, and any old activities
4752 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4753 */
4754 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4755 /**
4756 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4757 * this flag will cause a newly launching task to be placed on top of the current
4758 * home activity task (if there is one). That is, pressing back from the task
4759 * will always return the user to home even if that was not the last activity they
4760 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4761 */
4762 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4763 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004764 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4765 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004766 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004767 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004768 * this flag. When set and the task's activity is finished, the recents
4769 * entry will remain in the interface for the user to re-launch it, like a
4770 * recents entry for a top-level application.
4771 * <p>
4772 * The receiving activity can override this request with
4773 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4774 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004775 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004776 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004777 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004778
4779 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004780 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4781 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004782 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4783 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004784 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004785 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004786
4787 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004788 * If set, when sending a broadcast only registered receivers will be
4789 * called -- no BroadcastReceiver components will be launched.
4790 */
4791 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004792 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004793 * If set, when sending a broadcast the new broadcast will replace
4794 * any existing pending broadcast that matches it. Matching is defined
4795 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4796 * true for the intents of the two broadcasts. When a match is found,
4797 * the new broadcast (and receivers associated with it) will replace the
4798 * existing one in the pending broadcast list, remaining at the same
4799 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004800 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004801 * <p>This flag is most typically used with sticky broadcasts, which
4802 * only care about delivering the most recent values of the broadcast
4803 * to their receivers.
4804 */
4805 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4806 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004807 * If set, when sending a broadcast the recipient is allowed to run at
4808 * foreground priority, with a shorter timeout interval. During normal
4809 * broadcasts the receivers are not automatically hoisted out of the
4810 * background priority class.
4811 */
4812 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4813 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004814 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4815 * They can still propagate results through to later receivers, but they can not prevent
4816 * later receivers from seeing the broadcast.
4817 */
4818 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4819 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004820 * If set, when sending a broadcast <i>before boot has completed</i> only
4821 * registered receivers will be called -- no BroadcastReceiver components
4822 * will be launched. Sticky intent state will be recorded properly even
4823 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4824 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004825 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004826 * <p>This flag is only for use by system sevices as a convenience to
4827 * avoid having to implement a more complex mechanism around detection
4828 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004829 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004830 * @hide
4831 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004832 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004833 /**
4834 * Set when this broadcast is for a boot upgrade, a special mode that
4835 * allows the broadcast to be sent before the system is ready and launches
4836 * the app process with no providers running in it.
4837 * @hide
4838 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004839 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004840 /**
4841 * If set, the broadcast will always go to manifest receivers in background (cached
4842 * or not running) apps, regardless of whether that would be done by default. By
4843 * default they will only receive broadcasts if the broadcast has specified an
4844 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08004845 *
4846 * NOTE: dumpstate uses this flag numerically, so when its value is changed
4847 * the broadcast code there must also be changed to match.
4848 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004849 * @hide
4850 */
4851 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4852 /**
4853 * If set, the broadcast will never go to manifest receivers in background (cached
4854 * or not running) apps, regardless of whether that would be done by default. By
4855 * default they will receive broadcasts if the broadcast has specified an
4856 * explicit component or package name.
4857 * @hide
4858 */
4859 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07004860 /**
4861 * If set, this broadcast is being sent from the shell.
4862 * @hide
4863 */
4864 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004865
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004866 /**
4867 * @hide Flags that can't be changed with PendingIntent.
4868 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004869 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4870 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4871 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004872
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004874 // ---------------------------------------------------------------------
4875 // toUri() and parseUri() options.
4876
4877 /**
4878 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4879 * always has the "intent:" scheme. This syntax can be used when you want
4880 * to later disambiguate between URIs that are intended to describe an
4881 * Intent vs. all others that should be treated as raw URIs. When used
4882 * with {@link #parseUri}, any other scheme will result in a generic
4883 * VIEW action for that raw URI.
4884 */
4885 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004886
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004887 /**
4888 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4889 * always has the "android-app:" scheme. This is a variation of
4890 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4891 * http/https URI being delivered to a specific package name. The format
4892 * is:
4893 *
4894 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004895 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004896 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004897 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4898 * you must also include a scheme; including a path also requires both a host and a scheme.
4899 * The final #Intent; fragment can be used without a scheme, host, or path.
4900 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004901 * used with intents that have a {@link #setSelector}, since the base intent
4902 * will always have an explicit package name.</p>
4903 *
4904 * <p>Some examples of how this scheme maps to Intent objects:</p>
4905 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4906 * <colgroup align="left" />
4907 * <colgroup align="left" />
4908 * <thead>
4909 * <tr><th>URI</th> <th>Intent</th></tr>
4910 * </thead>
4911 *
4912 * <tbody>
4913 * <tr><td><code>android-app://com.example.app</code></td>
4914 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4915 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4916 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4917 * </table></td>
4918 * </tr>
4919 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4920 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4921 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4922 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4923 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4924 * </table></td>
4925 * </tr>
4926 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4927 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4928 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4929 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4930 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4931 * </table></td>
4932 * </tr>
4933 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4934 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4935 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4936 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4937 * </table></td>
4938 * </tr>
4939 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4940 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4941 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4942 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4943 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4944 * </table></td>
4945 * </tr>
4946 * <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>
4947 * <td><table border="" style="margin:0" >
4948 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4949 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4950 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4951 * </table></td>
4952 * </tr>
4953 * </tbody>
4954 * </table>
4955 */
4956 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4957
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004958 /**
4959 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4960 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4961 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4962 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4963 * generated Intent can not cause unexpected data access to happen.
4964 *
4965 * <p>If you do not trust the source of the URI being parsed, you should still do further
4966 * processing to protect yourself from it. In particular, when using it to start an
4967 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4968 * that can handle it.</p>
4969 */
4970 public static final int URI_ALLOW_UNSAFE = 1<<2;
4971
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004972 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004973
4974 private String mAction;
4975 private Uri mData;
4976 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004977 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004978 private ComponentName mComponent;
4979 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004980 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004981 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004982 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004983 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004984 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004985 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004986
4987 // ---------------------------------------------------------------------
4988
4989 /**
4990 * Create an empty intent.
4991 */
4992 public Intent() {
4993 }
4994
4995 /**
4996 * Copy constructor.
4997 */
4998 public Intent(Intent o) {
4999 this.mAction = o.mAction;
5000 this.mData = o.mData;
5001 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005002 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005003 this.mComponent = o.mComponent;
5004 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005005 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005006 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005007 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005008 }
5009 if (o.mExtras != null) {
5010 this.mExtras = new Bundle(o.mExtras);
5011 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005012 if (o.mSourceBounds != null) {
5013 this.mSourceBounds = new Rect(o.mSourceBounds);
5014 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005015 if (o.mSelector != null) {
5016 this.mSelector = new Intent(o.mSelector);
5017 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005018 if (o.mClipData != null) {
5019 this.mClipData = new ClipData(o.mClipData);
5020 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 }
5022
5023 @Override
5024 public Object clone() {
5025 return new Intent(this);
5026 }
5027
5028 private Intent(Intent o, boolean all) {
5029 this.mAction = o.mAction;
5030 this.mData = o.mData;
5031 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005032 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005033 this.mComponent = o.mComponent;
5034 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005035 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005036 }
5037 }
5038
5039 /**
5040 * Make a clone of only the parts of the Intent that are relevant for
5041 * filter matching: the action, data, type, component, and categories.
5042 */
5043 public Intent cloneFilter() {
5044 return new Intent(this, false);
5045 }
5046
5047 /**
5048 * Create an intent with a given action. All other fields (data, type,
5049 * class) are null. Note that the action <em>must</em> be in a
5050 * namespace because Intents are used globally in the system -- for
5051 * example the system VIEW action is android.intent.action.VIEW; an
5052 * application's custom action would be something like
5053 * com.google.app.myapp.CUSTOM_ACTION.
5054 *
5055 * @param action The Intent action, such as ACTION_VIEW.
5056 */
5057 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005058 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005059 }
5060
5061 /**
5062 * Create an intent with a given action and for a given data url. Note
5063 * that the action <em>must</em> be in a namespace because Intents are
5064 * used globally in the system -- for example the system VIEW action is
5065 * android.intent.action.VIEW; an application's custom action would be
5066 * something like com.google.app.myapp.CUSTOM_ACTION.
5067 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005068 * <p><em>Note: scheme and host name matching in the Android framework is
5069 * case-sensitive, unlike the formal RFC. As a result,
5070 * you should always ensure that you write your Uri with these elements
5071 * using lower case letters, and normalize any Uris you receive from
5072 * outside of Android to ensure the scheme and host is lower case.</em></p>
5073 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 * @param action The Intent action, such as ACTION_VIEW.
5075 * @param uri The Intent data URI.
5076 */
5077 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005078 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005079 mData = uri;
5080 }
5081
5082 /**
5083 * Create an intent for a specific component. All other fields (action, data,
5084 * type, class) are null, though they can be modified later with explicit
5085 * calls. This provides a convenient way to create an intent that is
5086 * intended to execute a hard-coded class name, rather than relying on the
5087 * system to find an appropriate class for you; see {@link #setComponent}
5088 * for more information on the repercussions of this.
5089 *
5090 * @param packageContext A Context of the application package implementing
5091 * this class.
5092 * @param cls The component class that is to be used for the intent.
5093 *
5094 * @see #setClass
5095 * @see #setComponent
5096 * @see #Intent(String, android.net.Uri , Context, Class)
5097 */
5098 public Intent(Context packageContext, Class<?> cls) {
5099 mComponent = new ComponentName(packageContext, cls);
5100 }
5101
5102 /**
5103 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005104 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005105 * construct the Intent and then calling {@link #setClass} to set its
5106 * class.
5107 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005108 * <p><em>Note: scheme and host name matching in the Android framework is
5109 * case-sensitive, unlike the formal RFC. As a result,
5110 * you should always ensure that you write your Uri with these elements
5111 * using lower case letters, and normalize any Uris you receive from
5112 * outside of Android to ensure the scheme and host is lower case.</em></p>
5113 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005114 * @param action The Intent action, such as ACTION_VIEW.
5115 * @param uri The Intent data URI.
5116 * @param packageContext A Context of the application package implementing
5117 * this class.
5118 * @param cls The component class that is to be used for the intent.
5119 *
5120 * @see #Intent(String, android.net.Uri)
5121 * @see #Intent(Context, Class)
5122 * @see #setClass
5123 * @see #setComponent
5124 */
5125 public Intent(String action, Uri uri,
5126 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005127 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005128 mData = uri;
5129 mComponent = new ComponentName(packageContext, cls);
5130 }
5131
5132 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005133 * Create an intent to launch the main (root) activity of a task. This
5134 * is the Intent that is started when the application's is launched from
5135 * Home. For anything else that wants to launch an application in the
5136 * same way, it is important that they use an Intent structured the same
5137 * way, and can use this function to ensure this is the case.
5138 *
5139 * <p>The returned Intent has the given Activity component as its explicit
5140 * component, {@link #ACTION_MAIN} as its action, and includes the
5141 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5142 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5143 * to do that through {@link #addFlags(int)} on the returned Intent.
5144 *
5145 * @param mainActivity The main activity component that this Intent will
5146 * launch.
5147 * @return Returns a newly created Intent that can be used to launch the
5148 * activity as a main application entry.
5149 *
5150 * @see #setClass
5151 * @see #setComponent
5152 */
5153 public static Intent makeMainActivity(ComponentName mainActivity) {
5154 Intent intent = new Intent(ACTION_MAIN);
5155 intent.setComponent(mainActivity);
5156 intent.addCategory(CATEGORY_LAUNCHER);
5157 return intent;
5158 }
5159
5160 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005161 * Make an Intent for the main activity of an application, without
5162 * specifying a specific activity to run but giving a selector to find
5163 * the activity. This results in a final Intent that is structured
5164 * the same as when the application is launched from
5165 * Home. For anything else that wants to launch an application in the
5166 * same way, it is important that they use an Intent structured the same
5167 * way, and can use this function to ensure this is the case.
5168 *
5169 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5170 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5171 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5172 * to do that through {@link #addFlags(int)} on the returned Intent.
5173 *
5174 * @param selectorAction The action name of the Intent's selector.
5175 * @param selectorCategory The name of a category to add to the Intent's
5176 * selector.
5177 * @return Returns a newly created Intent that can be used to launch the
5178 * activity as a main application entry.
5179 *
5180 * @see #setSelector(Intent)
5181 */
5182 public static Intent makeMainSelectorActivity(String selectorAction,
5183 String selectorCategory) {
5184 Intent intent = new Intent(ACTION_MAIN);
5185 intent.addCategory(CATEGORY_LAUNCHER);
5186 Intent selector = new Intent();
5187 selector.setAction(selectorAction);
5188 selector.addCategory(selectorCategory);
5189 intent.setSelector(selector);
5190 return intent;
5191 }
5192
5193 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005194 * Make an Intent that can be used to re-launch an application's task
5195 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5196 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5197 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5198 *
5199 * @param mainActivity The activity component that is the root of the
5200 * task; this is the activity that has been published in the application's
5201 * manifest as the main launcher icon.
5202 *
5203 * @return Returns a newly created Intent that can be used to relaunch the
5204 * activity's task in its root state.
5205 */
5206 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5207 Intent intent = makeMainActivity(mainActivity);
5208 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5209 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5210 return intent;
5211 }
5212
5213 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005214 * Call {@link #parseUri} with 0 flags.
5215 * @deprecated Use {@link #parseUri} instead.
5216 */
5217 @Deprecated
5218 public static Intent getIntent(String uri) throws URISyntaxException {
5219 return parseUri(uri, 0);
5220 }
Tom Taylord4a47292009-12-21 13:59:18 -08005221
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005222 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005223 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005224 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005225 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005226 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005227 *
5228 * <p>The URI given here must not be relative -- that is, it must include
5229 * the scheme and full path.
5230 *
5231 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005232 * @param flags Additional processing flags. Either 0,
5233 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005234 *
5235 * @return Intent The newly created Intent object.
5236 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005237 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5238 * it bad (as parsed by the Uri class) or the Intent data within the
5239 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005240 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005241 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005242 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005243 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005244 int i = 0;
5245 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005246 final boolean androidApp = uri.startsWith("android-app:");
5247
5248 // Validate intent scheme if requested.
5249 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5250 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005251 Intent intent = new Intent(ACTION_VIEW);
5252 try {
5253 intent.setData(Uri.parse(uri));
5254 } catch (IllegalArgumentException e) {
5255 throw new URISyntaxException(uri, e.getMessage());
5256 }
5257 return intent;
5258 }
5259 }
Tom Taylord4a47292009-12-21 13:59:18 -08005260
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005261 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005262 // simple case
5263 if (i == -1) {
5264 if (!androidApp) {
5265 return new Intent(ACTION_VIEW, Uri.parse(uri));
5266 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005267
5268 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005269 } else if (!uri.startsWith("#Intent;", i)) {
5270 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005271 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005272 } else {
5273 i = -1;
5274 }
5275 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005276
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005277 // new format
5278 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005279 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005280 boolean explicitAction = false;
5281 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005282
5283 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005284 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005285 String data;
5286 if (i >= 0) {
5287 data = uri.substring(0, i);
5288 i += 8; // length of "#Intent;"
5289 } else {
5290 data = uri;
5291 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005292
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005293 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005294 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005295 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005296 if (eq < 0) eq = i-1;
5297 int semi = uri.indexOf(';', i);
5298 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005299
5300 // action
5301 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005302 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005303 if (!inSelector) {
5304 explicitAction = true;
5305 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005306 }
5307
5308 // categories
5309 else if (uri.startsWith("category=", i)) {
5310 intent.addCategory(value);
5311 }
5312
5313 // type
5314 else if (uri.startsWith("type=", i)) {
5315 intent.mType = value;
5316 }
5317
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005318 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005319 else if (uri.startsWith("launchFlags=", i)) {
5320 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005321 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5322 intent.mFlags &= ~IMMUTABLE_FLAGS;
5323 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005324 }
5325
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005326 // package
5327 else if (uri.startsWith("package=", i)) {
5328 intent.mPackage = value;
5329 }
5330
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005331 // component
5332 else if (uri.startsWith("component=", i)) {
5333 intent.mComponent = ComponentName.unflattenFromString(value);
5334 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005335
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005336 // scheme
5337 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005338 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005339 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005340 } else {
5341 scheme = value;
5342 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005343 }
5344
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005345 // source bounds
5346 else if (uri.startsWith("sourceBounds=", i)) {
5347 intent.mSourceBounds = Rect.unflattenFromString(value);
5348 }
5349
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005350 // selector
5351 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5352 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005353 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005354 }
5355
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005356 // extra
5357 else {
5358 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005359 // create Bundle if it doesn't already exist
5360 if (intent.mExtras == null) intent.mExtras = new Bundle();
5361 Bundle b = intent.mExtras;
5362 // add EXTRA
5363 if (uri.startsWith("S.", i)) b.putString(key, value);
5364 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5365 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5366 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5367 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5368 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5369 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5370 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5371 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5372 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5373 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005374
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005375 // move to the next item
5376 i = semi + 1;
5377 }
5378
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005379 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005380 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005381 if (baseIntent.mPackage == null) {
5382 baseIntent.setSelector(intent);
5383 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005384 intent = baseIntent;
5385 }
5386
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005387 if (data != null) {
5388 if (data.startsWith("intent:")) {
5389 data = data.substring(7);
5390 if (scheme != null) {
5391 data = scheme + ':' + data;
5392 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005393 } else if (data.startsWith("android-app:")) {
5394 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5395 // Correctly formed android-app, first part is package name.
5396 int end = data.indexOf('/', 14);
5397 if (end < 0) {
5398 // All we have is a package name.
5399 intent.mPackage = data.substring(14);
5400 if (!explicitAction) {
5401 intent.setAction(ACTION_MAIN);
5402 }
5403 data = "";
5404 } else {
5405 // Target the Intent at the given package name always.
5406 String authority = null;
5407 intent.mPackage = data.substring(14, end);
5408 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005409 if ((end+1) < data.length()) {
5410 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5411 // Found a scheme, remember it.
5412 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005413 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005414 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5415 // Found a authority, remember it.
5416 authority = data.substring(end+1, newEnd);
5417 end = newEnd;
5418 }
5419 } else {
5420 // All we have is a scheme.
5421 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005422 }
5423 }
5424 if (scheme == null) {
5425 // If there was no scheme, then this just targets the package.
5426 if (!explicitAction) {
5427 intent.setAction(ACTION_MAIN);
5428 }
5429 data = "";
5430 } else if (authority == null) {
5431 data = scheme + ":";
5432 } else {
5433 data = scheme + "://" + authority + data.substring(end);
5434 }
5435 }
5436 } else {
5437 data = "";
5438 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005439 }
Tom Taylord4a47292009-12-21 13:59:18 -08005440
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005441 if (data.length() > 0) {
5442 try {
5443 intent.mData = Uri.parse(data);
5444 } catch (IllegalArgumentException e) {
5445 throw new URISyntaxException(uri, e.getMessage());
5446 }
5447 }
5448 }
Tom Taylord4a47292009-12-21 13:59:18 -08005449
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005450 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005451
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005452 } catch (IndexOutOfBoundsException e) {
5453 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5454 }
5455 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005456
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005457 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005458 return getIntentOld(uri, 0);
5459 }
5460
5461 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005462 Intent intent;
5463
5464 int i = uri.lastIndexOf('#');
5465 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005466 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005467 final int intentFragmentStart = i;
5468 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005469
5470 i++;
5471
5472 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005473 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005474 i += 7;
5475 int j = uri.indexOf(')', i);
5476 action = uri.substring(i, j);
5477 i = j + 1;
5478 }
5479
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005480 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005481
5482 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005483 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005484 i += 11;
5485 int j = uri.indexOf(')', i);
5486 while (i < j) {
5487 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005488 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005489 if (i < sep) {
5490 intent.addCategory(uri.substring(i, sep));
5491 }
5492 i = sep + 1;
5493 }
5494 i = j + 1;
5495 }
5496
5497 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005498 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005499 i += 5;
5500 int j = uri.indexOf(')', i);
5501 intent.mType = uri.substring(i, j);
5502 i = j + 1;
5503 }
5504
5505 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005506 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005507 i += 12;
5508 int j = uri.indexOf(')', i);
5509 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005510 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5511 intent.mFlags &= ~IMMUTABLE_FLAGS;
5512 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005513 i = j + 1;
5514 }
5515
5516 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005517 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005518 i += 10;
5519 int j = uri.indexOf(')', i);
5520 int sep = uri.indexOf('!', i);
5521 if (sep >= 0 && sep < j) {
5522 String pkg = uri.substring(i, sep);
5523 String cls = uri.substring(sep + 1, j);
5524 intent.mComponent = new ComponentName(pkg, cls);
5525 }
5526 i = j + 1;
5527 }
5528
5529 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005530 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005531 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005532
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005533 final int closeParen = uri.indexOf(')', i);
5534 if (closeParen == -1) throw new URISyntaxException(uri,
5535 "EXTRA missing trailing ')'", i);
5536
5537 while (i < closeParen) {
5538 // fetch the key value
5539 int j = uri.indexOf('=', i);
5540 if (j <= i + 1 || i >= closeParen) {
5541 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5542 }
5543 char type = uri.charAt(i);
5544 i++;
5545 String key = uri.substring(i, j);
5546 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005547
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005548 // get type-value
5549 j = uri.indexOf('!', i);
5550 if (j == -1 || j >= closeParen) j = closeParen;
5551 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5552 String value = uri.substring(i, j);
5553 i = j;
5554
5555 // create Bundle if it doesn't already exist
5556 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005557
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005558 // add item to bundle
5559 try {
5560 switch (type) {
5561 case 'S':
5562 intent.mExtras.putString(key, Uri.decode(value));
5563 break;
5564 case 'B':
5565 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5566 break;
5567 case 'b':
5568 intent.mExtras.putByte(key, Byte.parseByte(value));
5569 break;
5570 case 'c':
5571 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5572 break;
5573 case 'd':
5574 intent.mExtras.putDouble(key, Double.parseDouble(value));
5575 break;
5576 case 'f':
5577 intent.mExtras.putFloat(key, Float.parseFloat(value));
5578 break;
5579 case 'i':
5580 intent.mExtras.putInt(key, Integer.parseInt(value));
5581 break;
5582 case 'l':
5583 intent.mExtras.putLong(key, Long.parseLong(value));
5584 break;
5585 case 's':
5586 intent.mExtras.putShort(key, Short.parseShort(value));
5587 break;
5588 default:
5589 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5590 }
5591 } catch (NumberFormatException e) {
5592 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5593 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005594
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005595 char ch = uri.charAt(i);
5596 if (ch == ')') break;
5597 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5598 i++;
5599 }
5600 }
5601
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005602 if (isIntentFragment) {
5603 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5604 } else {
5605 intent.mData = Uri.parse(uri);
5606 }
Tom Taylord4a47292009-12-21 13:59:18 -08005607
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005608 if (intent.mAction == null) {
5609 // By default, if no action is specified, then use VIEW.
5610 intent.mAction = ACTION_VIEW;
5611 }
5612
5613 } else {
5614 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5615 }
5616
5617 return intent;
5618 }
5619
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005620 /** @hide */
5621 public interface CommandOptionHandler {
5622 boolean handleOption(String opt, ShellCommand cmd);
5623 }
5624
5625 /** @hide */
5626 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5627 throws URISyntaxException {
5628 Intent intent = new Intent();
5629 Intent baseIntent = intent;
5630 boolean hasIntentInfo = false;
5631
5632 Uri data = null;
5633 String type = null;
5634
5635 String opt;
5636 while ((opt=cmd.getNextOption()) != null) {
5637 switch (opt) {
5638 case "-a":
5639 intent.setAction(cmd.getNextArgRequired());
5640 if (intent == baseIntent) {
5641 hasIntentInfo = true;
5642 }
5643 break;
5644 case "-d":
5645 data = Uri.parse(cmd.getNextArgRequired());
5646 if (intent == baseIntent) {
5647 hasIntentInfo = true;
5648 }
5649 break;
5650 case "-t":
5651 type = cmd.getNextArgRequired();
5652 if (intent == baseIntent) {
5653 hasIntentInfo = true;
5654 }
5655 break;
5656 case "-c":
5657 intent.addCategory(cmd.getNextArgRequired());
5658 if (intent == baseIntent) {
5659 hasIntentInfo = true;
5660 }
5661 break;
5662 case "-e":
5663 case "--es": {
5664 String key = cmd.getNextArgRequired();
5665 String value = cmd.getNextArgRequired();
5666 intent.putExtra(key, value);
5667 }
5668 break;
5669 case "--esn": {
5670 String key = cmd.getNextArgRequired();
5671 intent.putExtra(key, (String) null);
5672 }
5673 break;
5674 case "--ei": {
5675 String key = cmd.getNextArgRequired();
5676 String value = cmd.getNextArgRequired();
5677 intent.putExtra(key, Integer.decode(value));
5678 }
5679 break;
5680 case "--eu": {
5681 String key = cmd.getNextArgRequired();
5682 String value = cmd.getNextArgRequired();
5683 intent.putExtra(key, Uri.parse(value));
5684 }
5685 break;
5686 case "--ecn": {
5687 String key = cmd.getNextArgRequired();
5688 String value = cmd.getNextArgRequired();
5689 ComponentName cn = ComponentName.unflattenFromString(value);
5690 if (cn == null)
5691 throw new IllegalArgumentException("Bad component name: " + value);
5692 intent.putExtra(key, cn);
5693 }
5694 break;
5695 case "--eia": {
5696 String key = cmd.getNextArgRequired();
5697 String value = cmd.getNextArgRequired();
5698 String[] strings = value.split(",");
5699 int[] list = new int[strings.length];
5700 for (int i = 0; i < strings.length; i++) {
5701 list[i] = Integer.decode(strings[i]);
5702 }
5703 intent.putExtra(key, list);
5704 }
5705 break;
5706 case "--eial": {
5707 String key = cmd.getNextArgRequired();
5708 String value = cmd.getNextArgRequired();
5709 String[] strings = value.split(",");
5710 ArrayList<Integer> list = new ArrayList<>(strings.length);
5711 for (int i = 0; i < strings.length; i++) {
5712 list.add(Integer.decode(strings[i]));
5713 }
5714 intent.putExtra(key, list);
5715 }
5716 break;
5717 case "--el": {
5718 String key = cmd.getNextArgRequired();
5719 String value = cmd.getNextArgRequired();
5720 intent.putExtra(key, Long.valueOf(value));
5721 }
5722 break;
5723 case "--ela": {
5724 String key = cmd.getNextArgRequired();
5725 String value = cmd.getNextArgRequired();
5726 String[] strings = value.split(",");
5727 long[] list = new long[strings.length];
5728 for (int i = 0; i < strings.length; i++) {
5729 list[i] = Long.valueOf(strings[i]);
5730 }
5731 intent.putExtra(key, list);
5732 hasIntentInfo = true;
5733 }
5734 break;
5735 case "--elal": {
5736 String key = cmd.getNextArgRequired();
5737 String value = cmd.getNextArgRequired();
5738 String[] strings = value.split(",");
5739 ArrayList<Long> list = new ArrayList<>(strings.length);
5740 for (int i = 0; i < strings.length; i++) {
5741 list.add(Long.valueOf(strings[i]));
5742 }
5743 intent.putExtra(key, list);
5744 hasIntentInfo = true;
5745 }
5746 break;
5747 case "--ef": {
5748 String key = cmd.getNextArgRequired();
5749 String value = cmd.getNextArgRequired();
5750 intent.putExtra(key, Float.valueOf(value));
5751 hasIntentInfo = true;
5752 }
5753 break;
5754 case "--efa": {
5755 String key = cmd.getNextArgRequired();
5756 String value = cmd.getNextArgRequired();
5757 String[] strings = value.split(",");
5758 float[] list = new float[strings.length];
5759 for (int i = 0; i < strings.length; i++) {
5760 list[i] = Float.valueOf(strings[i]);
5761 }
5762 intent.putExtra(key, list);
5763 hasIntentInfo = true;
5764 }
5765 break;
5766 case "--efal": {
5767 String key = cmd.getNextArgRequired();
5768 String value = cmd.getNextArgRequired();
5769 String[] strings = value.split(",");
5770 ArrayList<Float> list = new ArrayList<>(strings.length);
5771 for (int i = 0; i < strings.length; i++) {
5772 list.add(Float.valueOf(strings[i]));
5773 }
5774 intent.putExtra(key, list);
5775 hasIntentInfo = true;
5776 }
5777 break;
5778 case "--esa": {
5779 String key = cmd.getNextArgRequired();
5780 String value = cmd.getNextArgRequired();
5781 // Split on commas unless they are preceeded by an escape.
5782 // The escape character must be escaped for the string and
5783 // again for the regex, thus four escape characters become one.
5784 String[] strings = value.split("(?<!\\\\),");
5785 intent.putExtra(key, strings);
5786 hasIntentInfo = true;
5787 }
5788 break;
5789 case "--esal": {
5790 String key = cmd.getNextArgRequired();
5791 String value = cmd.getNextArgRequired();
5792 // Split on commas unless they are preceeded by an escape.
5793 // The escape character must be escaped for the string and
5794 // again for the regex, thus four escape characters become one.
5795 String[] strings = value.split("(?<!\\\\),");
5796 ArrayList<String> list = new ArrayList<>(strings.length);
5797 for (int i = 0; i < strings.length; i++) {
5798 list.add(strings[i]);
5799 }
5800 intent.putExtra(key, list);
5801 hasIntentInfo = true;
5802 }
5803 break;
5804 case "--ez": {
5805 String key = cmd.getNextArgRequired();
5806 String value = cmd.getNextArgRequired().toLowerCase();
5807 // Boolean.valueOf() results in false for anything that is not "true", which is
5808 // error-prone in shell commands
5809 boolean arg;
5810 if ("true".equals(value) || "t".equals(value)) {
5811 arg = true;
5812 } else if ("false".equals(value) || "f".equals(value)) {
5813 arg = false;
5814 } else {
5815 try {
5816 arg = Integer.decode(value) != 0;
5817 } catch (NumberFormatException ex) {
5818 throw new IllegalArgumentException("Invalid boolean value: " + value);
5819 }
5820 }
5821
5822 intent.putExtra(key, arg);
5823 }
5824 break;
5825 case "-n": {
5826 String str = cmd.getNextArgRequired();
5827 ComponentName cn = ComponentName.unflattenFromString(str);
5828 if (cn == null)
5829 throw new IllegalArgumentException("Bad component name: " + str);
5830 intent.setComponent(cn);
5831 if (intent == baseIntent) {
5832 hasIntentInfo = true;
5833 }
5834 }
5835 break;
5836 case "-p": {
5837 String str = cmd.getNextArgRequired();
5838 intent.setPackage(str);
5839 if (intent == baseIntent) {
5840 hasIntentInfo = true;
5841 }
5842 }
5843 break;
5844 case "-f":
5845 String str = cmd.getNextArgRequired();
5846 intent.setFlags(Integer.decode(str).intValue());
5847 break;
5848 case "--grant-read-uri-permission":
5849 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5850 break;
5851 case "--grant-write-uri-permission":
5852 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5853 break;
5854 case "--grant-persistable-uri-permission":
5855 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5856 break;
5857 case "--grant-prefix-uri-permission":
5858 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5859 break;
5860 case "--exclude-stopped-packages":
5861 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5862 break;
5863 case "--include-stopped-packages":
5864 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5865 break;
5866 case "--debug-log-resolution":
5867 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5868 break;
5869 case "--activity-brought-to-front":
5870 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5871 break;
5872 case "--activity-clear-top":
5873 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5874 break;
5875 case "--activity-clear-when-task-reset":
5876 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5877 break;
5878 case "--activity-exclude-from-recents":
5879 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5880 break;
5881 case "--activity-launched-from-history":
5882 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5883 break;
5884 case "--activity-multiple-task":
5885 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5886 break;
5887 case "--activity-no-animation":
5888 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5889 break;
5890 case "--activity-no-history":
5891 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5892 break;
5893 case "--activity-no-user-action":
5894 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5895 break;
5896 case "--activity-previous-is-top":
5897 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5898 break;
5899 case "--activity-reorder-to-front":
5900 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5901 break;
5902 case "--activity-reset-task-if-needed":
5903 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5904 break;
5905 case "--activity-single-top":
5906 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5907 break;
5908 case "--activity-clear-task":
5909 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5910 break;
5911 case "--activity-task-on-home":
5912 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5913 break;
5914 case "--receiver-registered-only":
5915 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5916 break;
5917 case "--receiver-replace-pending":
5918 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5919 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005920 case "--receiver-foreground":
5921 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5922 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005923 case "--selector":
5924 intent.setDataAndType(data, type);
5925 intent = new Intent();
5926 break;
5927 default:
5928 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5929 // Okay, caller handled this option.
5930 } else {
5931 throw new IllegalArgumentException("Unknown option: " + opt);
5932 }
5933 break;
5934 }
5935 }
5936 intent.setDataAndType(data, type);
5937
5938 final boolean hasSelector = intent != baseIntent;
5939 if (hasSelector) {
5940 // A selector was specified; fix up.
5941 baseIntent.setSelector(intent);
5942 intent = baseIntent;
5943 }
5944
5945 String arg = cmd.getNextArg();
5946 baseIntent = null;
5947 if (arg == null) {
5948 if (hasSelector) {
5949 // If a selector has been specified, and no arguments
5950 // have been supplied for the main Intent, then we can
5951 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5952 // need to have a component name specified yet, the
5953 // selector will take care of that.
5954 baseIntent = new Intent(Intent.ACTION_MAIN);
5955 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5956 }
5957 } else if (arg.indexOf(':') >= 0) {
5958 // The argument is a URI. Fully parse it, and use that result
5959 // to fill in any data not specified so far.
5960 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5961 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5962 } else if (arg.indexOf('/') >= 0) {
5963 // The argument is a component name. Build an Intent to launch
5964 // it.
5965 baseIntent = new Intent(Intent.ACTION_MAIN);
5966 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5967 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5968 } else {
5969 // Assume the argument is a package name.
5970 baseIntent = new Intent(Intent.ACTION_MAIN);
5971 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5972 baseIntent.setPackage(arg);
5973 }
5974 if (baseIntent != null) {
5975 Bundle extras = intent.getExtras();
5976 intent.replaceExtras((Bundle)null);
5977 Bundle uriExtras = baseIntent.getExtras();
5978 baseIntent.replaceExtras((Bundle)null);
5979 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5980 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5981 for (String c : cats) {
5982 baseIntent.removeCategory(c);
5983 }
5984 }
5985 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5986 if (extras == null) {
5987 extras = uriExtras;
5988 } else if (uriExtras != null) {
5989 uriExtras.putAll(extras);
5990 extras = uriExtras;
5991 }
5992 intent.replaceExtras(extras);
5993 hasIntentInfo = true;
5994 }
5995
5996 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5997 return intent;
5998 }
5999
6000 /** @hide */
6001 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6002 final String[] lines = new String[] {
6003 "<INTENT> specifications include these flags and arguments:",
6004 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6005 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6006 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6007 " [--esn <EXTRA_KEY> ...]",
6008 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6009 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6010 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6011 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6012 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6013 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6014 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6015 " (mutiple extras passed as Integer[])",
6016 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6017 " (mutiple extras passed as List<Integer>)",
6018 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6019 " (mutiple extras passed as Long[])",
6020 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6021 " (mutiple extras passed as List<Long>)",
6022 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6023 " (mutiple extras passed as Float[])",
6024 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6025 " (mutiple extras passed as List<Float>)",
6026 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6027 " (mutiple extras passed as String[]; to embed a comma into a string,",
6028 " escape it using \"\\,\")",
6029 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6030 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6031 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006032 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006033 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6034 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6035 " [--debug-log-resolution] [--exclude-stopped-packages]",
6036 " [--include-stopped-packages]",
6037 " [--activity-brought-to-front] [--activity-clear-top]",
6038 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6039 " [--activity-launched-from-history] [--activity-multiple-task]",
6040 " [--activity-no-animation] [--activity-no-history]",
6041 " [--activity-no-user-action] [--activity-previous-is-top]",
6042 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6043 " [--activity-single-top] [--activity-clear-task]",
6044 " [--activity-task-on-home]",
6045 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006046 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006047 " [--selector]",
6048 " [<URI> | <PACKAGE> | <COMPONENT>]"
6049 };
6050 for (String line : lines) {
6051 pw.print(prefix);
6052 pw.println(line);
6053 }
6054 }
6055
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006056 /**
6057 * Retrieve the general action to be performed, such as
6058 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6059 * the information in the intent should be interpreted -- most importantly,
6060 * what to do with the data returned by {@link #getData}.
6061 *
6062 * @return The action of this intent or null if none is specified.
6063 *
6064 * @see #setAction
6065 */
6066 public String getAction() {
6067 return mAction;
6068 }
6069
6070 /**
6071 * Retrieve data this intent is operating on. This URI specifies the name
6072 * of the data; often it uses the content: scheme, specifying data in a
6073 * content provider. Other schemes may be handled by specific activities,
6074 * such as http: by the web browser.
6075 *
6076 * @return The URI of the data this intent is targeting or null.
6077 *
6078 * @see #getScheme
6079 * @see #setData
6080 */
6081 public Uri getData() {
6082 return mData;
6083 }
6084
6085 /**
6086 * The same as {@link #getData()}, but returns the URI as an encoded
6087 * String.
6088 */
6089 public String getDataString() {
6090 return mData != null ? mData.toString() : null;
6091 }
6092
6093 /**
6094 * Return the scheme portion of the intent's data. If the data is null or
6095 * does not include a scheme, null is returned. Otherwise, the scheme
6096 * prefix without the final ':' is returned, i.e. "http".
6097 *
6098 * <p>This is the same as calling getData().getScheme() (and checking for
6099 * null data).
6100 *
6101 * @return The scheme of this intent.
6102 *
6103 * @see #getData
6104 */
6105 public String getScheme() {
6106 return mData != null ? mData.getScheme() : null;
6107 }
6108
6109 /**
6110 * Retrieve any explicit MIME type included in the intent. This is usually
6111 * null, as the type is determined by the intent data.
6112 *
6113 * @return If a type was manually set, it is returned; else null is
6114 * returned.
6115 *
6116 * @see #resolveType(ContentResolver)
6117 * @see #setType
6118 */
6119 public String getType() {
6120 return mType;
6121 }
6122
6123 /**
6124 * Return the MIME data type of this intent. If the type field is
6125 * explicitly set, that is simply returned. Otherwise, if the data is set,
6126 * the type of that data is returned. If neither fields are set, a null is
6127 * returned.
6128 *
6129 * @return The MIME type of this intent.
6130 *
6131 * @see #getType
6132 * @see #resolveType(ContentResolver)
6133 */
6134 public String resolveType(Context context) {
6135 return resolveType(context.getContentResolver());
6136 }
6137
6138 /**
6139 * Return the MIME data type of this intent. If the type field is
6140 * explicitly set, that is simply returned. Otherwise, if the data is set,
6141 * the type of that data is returned. If neither fields are set, a null is
6142 * returned.
6143 *
6144 * @param resolver A ContentResolver that can be used to determine the MIME
6145 * type of the intent's data.
6146 *
6147 * @return The MIME type of this intent.
6148 *
6149 * @see #getType
6150 * @see #resolveType(Context)
6151 */
6152 public String resolveType(ContentResolver resolver) {
6153 if (mType != null) {
6154 return mType;
6155 }
6156 if (mData != null) {
6157 if ("content".equals(mData.getScheme())) {
6158 return resolver.getType(mData);
6159 }
6160 }
6161 return null;
6162 }
6163
6164 /**
6165 * Return the MIME data type of this intent, only if it will be needed for
6166 * intent resolution. This is not generally useful for application code;
6167 * it is used by the frameworks for communicating with back-end system
6168 * services.
6169 *
6170 * @param resolver A ContentResolver that can be used to determine the MIME
6171 * type of the intent's data.
6172 *
6173 * @return The MIME type of this intent, or null if it is unknown or not
6174 * needed.
6175 */
6176 public String resolveTypeIfNeeded(ContentResolver resolver) {
6177 if (mComponent != null) {
6178 return mType;
6179 }
6180 return resolveType(resolver);
6181 }
6182
6183 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006184 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006185 *
6186 * @param category The category to check.
6187 *
6188 * @return boolean True if the intent contains the category, else false.
6189 *
6190 * @see #getCategories
6191 * @see #addCategory
6192 */
6193 public boolean hasCategory(String category) {
6194 return mCategories != null && mCategories.contains(category);
6195 }
6196
6197 /**
6198 * Return the set of all categories in the intent. If there are no categories,
6199 * returns NULL.
6200 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006201 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006202 *
6203 * @see #hasCategory
6204 * @see #addCategory
6205 */
6206 public Set<String> getCategories() {
6207 return mCategories;
6208 }
6209
6210 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006211 * Return the specific selector associated with this Intent. If there is
6212 * none, returns null. See {@link #setSelector} for more information.
6213 *
6214 * @see #setSelector
6215 */
6216 public Intent getSelector() {
6217 return mSelector;
6218 }
6219
6220 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006221 * Return the {@link ClipData} associated with this Intent. If there is
6222 * none, returns null. See {@link #setClipData} for more information.
6223 *
John Spurlock125d1332013-11-25 11:58:37 -05006224 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006225 */
6226 public ClipData getClipData() {
6227 return mClipData;
6228 }
6229
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006230 /** @hide */
6231 public int getContentUserHint() {
6232 return mContentUserHint;
6233 }
6234
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006235 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006236 * Sets the ClassLoader that will be used when unmarshalling
6237 * any Parcelable values from the extras of this Intent.
6238 *
6239 * @param loader a ClassLoader, or null to use the default loader
6240 * at the time of unmarshalling.
6241 */
6242 public void setExtrasClassLoader(ClassLoader loader) {
6243 if (mExtras != null) {
6244 mExtras.setClassLoader(loader);
6245 }
6246 }
6247
6248 /**
6249 * Returns true if an extra value is associated with the given name.
6250 * @param name the extra's name
6251 * @return true if the given extra is present.
6252 */
6253 public boolean hasExtra(String name) {
6254 return mExtras != null && mExtras.containsKey(name);
6255 }
6256
6257 /**
6258 * Returns true if the Intent's extras contain a parcelled file descriptor.
6259 * @return true if the Intent contains a parcelled file descriptor.
6260 */
6261 public boolean hasFileDescriptors() {
6262 return mExtras != null && mExtras.hasFileDescriptors();
6263 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006264
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006265 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006266 public void setAllowFds(boolean allowFds) {
6267 if (mExtras != null) {
6268 mExtras.setAllowFds(allowFds);
6269 }
6270 }
6271
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006272 /** {@hide} */
6273 public void setDefusable(boolean defusable) {
6274 if (mExtras != null) {
6275 mExtras.setDefusable(defusable);
6276 }
6277 }
6278
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006279 /**
6280 * Retrieve extended data from the intent.
6281 *
6282 * @param name The name of the desired item.
6283 *
6284 * @return the value of an item that previously added with putExtra()
6285 * or null if none was found.
6286 *
6287 * @deprecated
6288 * @hide
6289 */
6290 @Deprecated
6291 public Object getExtra(String name) {
6292 return getExtra(name, null);
6293 }
6294
6295 /**
6296 * Retrieve extended data from the intent.
6297 *
6298 * @param name The name of the desired item.
6299 * @param defaultValue the value to be returned if no value of the desired
6300 * type is stored with the given name.
6301 *
6302 * @return the value of an item that previously added with putExtra()
6303 * or the default value if none was found.
6304 *
6305 * @see #putExtra(String, boolean)
6306 */
6307 public boolean getBooleanExtra(String name, boolean defaultValue) {
6308 return mExtras == null ? defaultValue :
6309 mExtras.getBoolean(name, defaultValue);
6310 }
6311
6312 /**
6313 * Retrieve extended data from the intent.
6314 *
6315 * @param name The name of the desired item.
6316 * @param defaultValue the value to be returned if no value of the desired
6317 * type is stored with the given name.
6318 *
6319 * @return the value of an item that previously added with putExtra()
6320 * or the default value if none was found.
6321 *
6322 * @see #putExtra(String, byte)
6323 */
6324 public byte getByteExtra(String name, byte defaultValue) {
6325 return mExtras == null ? defaultValue :
6326 mExtras.getByte(name, defaultValue);
6327 }
6328
6329 /**
6330 * Retrieve extended data from the intent.
6331 *
6332 * @param name The name of the desired item.
6333 * @param defaultValue the value to be returned if no value of the desired
6334 * type is stored with the given name.
6335 *
6336 * @return the value of an item that previously added with putExtra()
6337 * or the default value if none was found.
6338 *
6339 * @see #putExtra(String, short)
6340 */
6341 public short getShortExtra(String name, short defaultValue) {
6342 return mExtras == null ? defaultValue :
6343 mExtras.getShort(name, defaultValue);
6344 }
6345
6346 /**
6347 * Retrieve extended data from the intent.
6348 *
6349 * @param name The name of the desired item.
6350 * @param defaultValue the value to be returned if no value of the desired
6351 * type is stored with the given name.
6352 *
6353 * @return the value of an item that previously added with putExtra()
6354 * or the default value if none was found.
6355 *
6356 * @see #putExtra(String, char)
6357 */
6358 public char getCharExtra(String name, char defaultValue) {
6359 return mExtras == null ? defaultValue :
6360 mExtras.getChar(name, defaultValue);
6361 }
6362
6363 /**
6364 * Retrieve extended data from the intent.
6365 *
6366 * @param name The name of the desired item.
6367 * @param defaultValue the value to be returned if no value of the desired
6368 * type is stored with the given name.
6369 *
6370 * @return the value of an item that previously added with putExtra()
6371 * or the default value if none was found.
6372 *
6373 * @see #putExtra(String, int)
6374 */
6375 public int getIntExtra(String name, int defaultValue) {
6376 return mExtras == null ? defaultValue :
6377 mExtras.getInt(name, defaultValue);
6378 }
6379
6380 /**
6381 * Retrieve extended data from the intent.
6382 *
6383 * @param name The name of the desired item.
6384 * @param defaultValue the value to be returned if no value of the desired
6385 * type is stored with the given name.
6386 *
6387 * @return the value of an item that previously added with putExtra()
6388 * or the default value if none was found.
6389 *
6390 * @see #putExtra(String, long)
6391 */
6392 public long getLongExtra(String name, long defaultValue) {
6393 return mExtras == null ? defaultValue :
6394 mExtras.getLong(name, defaultValue);
6395 }
6396
6397 /**
6398 * Retrieve extended data from the intent.
6399 *
6400 * @param name The name of the desired item.
6401 * @param defaultValue the value to be returned if no value of the desired
6402 * type is stored with the given name.
6403 *
6404 * @return the value of an item that previously added with putExtra(),
6405 * or the default value if no such item is present
6406 *
6407 * @see #putExtra(String, float)
6408 */
6409 public float getFloatExtra(String name, float defaultValue) {
6410 return mExtras == null ? defaultValue :
6411 mExtras.getFloat(name, defaultValue);
6412 }
6413
6414 /**
6415 * Retrieve extended data from the intent.
6416 *
6417 * @param name The name of the desired item.
6418 * @param defaultValue the value to be returned if no value of the desired
6419 * type is stored with the given name.
6420 *
6421 * @return the value of an item that previously added with putExtra()
6422 * or the default value if none was found.
6423 *
6424 * @see #putExtra(String, double)
6425 */
6426 public double getDoubleExtra(String name, double defaultValue) {
6427 return mExtras == null ? defaultValue :
6428 mExtras.getDouble(name, defaultValue);
6429 }
6430
6431 /**
6432 * Retrieve extended data from the intent.
6433 *
6434 * @param name The name of the desired item.
6435 *
6436 * @return the value of an item that previously added with putExtra()
6437 * or null if no String value was found.
6438 *
6439 * @see #putExtra(String, String)
6440 */
6441 public String getStringExtra(String name) {
6442 return mExtras == null ? null : mExtras.getString(name);
6443 }
6444
6445 /**
6446 * Retrieve extended data from the intent.
6447 *
6448 * @param name The name of the desired item.
6449 *
6450 * @return the value of an item that previously added with putExtra()
6451 * or null if no CharSequence value was found.
6452 *
6453 * @see #putExtra(String, CharSequence)
6454 */
6455 public CharSequence getCharSequenceExtra(String name) {
6456 return mExtras == null ? null : mExtras.getCharSequence(name);
6457 }
6458
6459 /**
6460 * Retrieve extended data from the intent.
6461 *
6462 * @param name The name of the desired item.
6463 *
6464 * @return the value of an item that previously added with putExtra()
6465 * or null if no Parcelable value was found.
6466 *
6467 * @see #putExtra(String, Parcelable)
6468 */
6469 public <T extends Parcelable> T getParcelableExtra(String name) {
6470 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6471 }
6472
6473 /**
6474 * Retrieve extended data from the intent.
6475 *
6476 * @param name The name of the desired item.
6477 *
6478 * @return the value of an item that previously added with putExtra()
6479 * or null if no Parcelable[] value was found.
6480 *
6481 * @see #putExtra(String, Parcelable[])
6482 */
6483 public Parcelable[] getParcelableArrayExtra(String name) {
6484 return mExtras == null ? null : mExtras.getParcelableArray(name);
6485 }
6486
6487 /**
6488 * Retrieve extended data from the intent.
6489 *
6490 * @param name The name of the desired item.
6491 *
6492 * @return the value of an item that previously added with putExtra()
6493 * or null if no ArrayList<Parcelable> value was found.
6494 *
6495 * @see #putParcelableArrayListExtra(String, ArrayList)
6496 */
6497 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6498 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6499 }
6500
6501 /**
6502 * Retrieve extended data from the intent.
6503 *
6504 * @param name The name of the desired item.
6505 *
6506 * @return the value of an item that previously added with putExtra()
6507 * or null if no Serializable value was found.
6508 *
6509 * @see #putExtra(String, Serializable)
6510 */
6511 public Serializable getSerializableExtra(String name) {
6512 return mExtras == null ? null : mExtras.getSerializable(name);
6513 }
6514
6515 /**
6516 * Retrieve extended data from the intent.
6517 *
6518 * @param name The name of the desired item.
6519 *
6520 * @return the value of an item that previously added with putExtra()
6521 * or null if no ArrayList<Integer> value was found.
6522 *
6523 * @see #putIntegerArrayListExtra(String, ArrayList)
6524 */
6525 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6526 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6527 }
6528
6529 /**
6530 * Retrieve extended data from the intent.
6531 *
6532 * @param name The name of the desired item.
6533 *
6534 * @return the value of an item that previously added with putExtra()
6535 * or null if no ArrayList<String> value was found.
6536 *
6537 * @see #putStringArrayListExtra(String, ArrayList)
6538 */
6539 public ArrayList<String> getStringArrayListExtra(String name) {
6540 return mExtras == null ? null : mExtras.getStringArrayList(name);
6541 }
6542
6543 /**
6544 * Retrieve extended data from the intent.
6545 *
6546 * @param name The name of the desired item.
6547 *
6548 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006549 * or null if no ArrayList<CharSequence> value was found.
6550 *
6551 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6552 */
6553 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6554 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6555 }
6556
6557 /**
6558 * Retrieve extended data from the intent.
6559 *
6560 * @param name The name of the desired item.
6561 *
6562 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006563 * or null if no boolean array value was found.
6564 *
6565 * @see #putExtra(String, boolean[])
6566 */
6567 public boolean[] getBooleanArrayExtra(String name) {
6568 return mExtras == null ? null : mExtras.getBooleanArray(name);
6569 }
6570
6571 /**
6572 * Retrieve extended data from the intent.
6573 *
6574 * @param name The name of the desired item.
6575 *
6576 * @return the value of an item that previously added with putExtra()
6577 * or null if no byte array value was found.
6578 *
6579 * @see #putExtra(String, byte[])
6580 */
6581 public byte[] getByteArrayExtra(String name) {
6582 return mExtras == null ? null : mExtras.getByteArray(name);
6583 }
6584
6585 /**
6586 * Retrieve extended data from the intent.
6587 *
6588 * @param name The name of the desired item.
6589 *
6590 * @return the value of an item that previously added with putExtra()
6591 * or null if no short array value was found.
6592 *
6593 * @see #putExtra(String, short[])
6594 */
6595 public short[] getShortArrayExtra(String name) {
6596 return mExtras == null ? null : mExtras.getShortArray(name);
6597 }
6598
6599 /**
6600 * Retrieve extended data from the intent.
6601 *
6602 * @param name The name of the desired item.
6603 *
6604 * @return the value of an item that previously added with putExtra()
6605 * or null if no char array value was found.
6606 *
6607 * @see #putExtra(String, char[])
6608 */
6609 public char[] getCharArrayExtra(String name) {
6610 return mExtras == null ? null : mExtras.getCharArray(name);
6611 }
6612
6613 /**
6614 * Retrieve extended data from the intent.
6615 *
6616 * @param name The name of the desired item.
6617 *
6618 * @return the value of an item that previously added with putExtra()
6619 * or null if no int array value was found.
6620 *
6621 * @see #putExtra(String, int[])
6622 */
6623 public int[] getIntArrayExtra(String name) {
6624 return mExtras == null ? null : mExtras.getIntArray(name);
6625 }
6626
6627 /**
6628 * Retrieve extended data from the intent.
6629 *
6630 * @param name The name of the desired item.
6631 *
6632 * @return the value of an item that previously added with putExtra()
6633 * or null if no long array value was found.
6634 *
6635 * @see #putExtra(String, long[])
6636 */
6637 public long[] getLongArrayExtra(String name) {
6638 return mExtras == null ? null : mExtras.getLongArray(name);
6639 }
6640
6641 /**
6642 * Retrieve extended data from the intent.
6643 *
6644 * @param name The name of the desired item.
6645 *
6646 * @return the value of an item that previously added with putExtra()
6647 * or null if no float array value was found.
6648 *
6649 * @see #putExtra(String, float[])
6650 */
6651 public float[] getFloatArrayExtra(String name) {
6652 return mExtras == null ? null : mExtras.getFloatArray(name);
6653 }
6654
6655 /**
6656 * Retrieve extended data from the intent.
6657 *
6658 * @param name The name of the desired item.
6659 *
6660 * @return the value of an item that previously added with putExtra()
6661 * or null if no double array value was found.
6662 *
6663 * @see #putExtra(String, double[])
6664 */
6665 public double[] getDoubleArrayExtra(String name) {
6666 return mExtras == null ? null : mExtras.getDoubleArray(name);
6667 }
6668
6669 /**
6670 * Retrieve extended data from the intent.
6671 *
6672 * @param name The name of the desired item.
6673 *
6674 * @return the value of an item that previously added with putExtra()
6675 * or null if no String array value was found.
6676 *
6677 * @see #putExtra(String, String[])
6678 */
6679 public String[] getStringArrayExtra(String name) {
6680 return mExtras == null ? null : mExtras.getStringArray(name);
6681 }
6682
6683 /**
6684 * Retrieve extended data from the intent.
6685 *
6686 * @param name The name of the desired item.
6687 *
6688 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006689 * or null if no CharSequence array value was found.
6690 *
6691 * @see #putExtra(String, CharSequence[])
6692 */
6693 public CharSequence[] getCharSequenceArrayExtra(String name) {
6694 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6695 }
6696
6697 /**
6698 * Retrieve extended data from the intent.
6699 *
6700 * @param name The name of the desired item.
6701 *
6702 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006703 * or null if no Bundle value was found.
6704 *
6705 * @see #putExtra(String, Bundle)
6706 */
6707 public Bundle getBundleExtra(String name) {
6708 return mExtras == null ? null : mExtras.getBundle(name);
6709 }
6710
6711 /**
6712 * Retrieve extended data from the intent.
6713 *
6714 * @param name The name of the desired item.
6715 *
6716 * @return the value of an item that previously added with putExtra()
6717 * or null if no IBinder value was found.
6718 *
6719 * @see #putExtra(String, IBinder)
6720 *
6721 * @deprecated
6722 * @hide
6723 */
6724 @Deprecated
6725 public IBinder getIBinderExtra(String name) {
6726 return mExtras == null ? null : mExtras.getIBinder(name);
6727 }
6728
6729 /**
6730 * Retrieve extended data from the intent.
6731 *
6732 * @param name The name of the desired item.
6733 * @param defaultValue The default value to return in case no item is
6734 * associated with the key 'name'
6735 *
6736 * @return the value of an item that previously added with putExtra()
6737 * or defaultValue if none was found.
6738 *
6739 * @see #putExtra
6740 *
6741 * @deprecated
6742 * @hide
6743 */
6744 @Deprecated
6745 public Object getExtra(String name, Object defaultValue) {
6746 Object result = defaultValue;
6747 if (mExtras != null) {
6748 Object result2 = mExtras.get(name);
6749 if (result2 != null) {
6750 result = result2;
6751 }
6752 }
6753
6754 return result;
6755 }
6756
6757 /**
6758 * Retrieves a map of extended data from the intent.
6759 *
6760 * @return the map of all extras previously added with putExtra(),
6761 * or null if none have been added.
6762 */
6763 public Bundle getExtras() {
6764 return (mExtras != null)
6765 ? new Bundle(mExtras)
6766 : null;
6767 }
6768
6769 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006770 * Filter extras to only basic types.
6771 * @hide
6772 */
6773 public void removeUnsafeExtras() {
6774 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006775 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006776 }
6777 }
6778
6779 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006780 * Retrieve any special flags associated with this intent. You will
6781 * normally just set them with {@link #setFlags} and let the system
6782 * take the appropriate action with them.
6783 *
6784 * @return int The currently set flags.
6785 *
6786 * @see #setFlags
6787 */
6788 public int getFlags() {
6789 return mFlags;
6790 }
6791
Dianne Hackborne7f97212011-02-24 14:40:20 -08006792 /** @hide */
6793 public boolean isExcludingStopped() {
6794 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6795 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6796 }
6797
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006798 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006799 * Retrieve the application package name this Intent is limited to. When
6800 * resolving an Intent, if non-null this limits the resolution to only
6801 * components in the given application package.
6802 *
6803 * @return The name of the application package for the Intent.
6804 *
6805 * @see #resolveActivity
6806 * @see #setPackage
6807 */
6808 public String getPackage() {
6809 return mPackage;
6810 }
6811
6812 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006813 * Retrieve the concrete component associated with the intent. When receiving
6814 * an intent, this is the component that was found to best handle it (that is,
6815 * yourself) and will always be non-null; in all other cases it will be
6816 * null unless explicitly set.
6817 *
6818 * @return The name of the application component to handle the intent.
6819 *
6820 * @see #resolveActivity
6821 * @see #setComponent
6822 */
6823 public ComponentName getComponent() {
6824 return mComponent;
6825 }
6826
6827 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006828 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6829 * used as a hint to the receiver for animations and the like. Null means that there
6830 * is no source bounds.
6831 */
6832 public Rect getSourceBounds() {
6833 return mSourceBounds;
6834 }
6835
6836 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006837 * Return the Activity component that should be used to handle this intent.
6838 * The appropriate component is determined based on the information in the
6839 * intent, evaluated as follows:
6840 *
6841 * <p>If {@link #getComponent} returns an explicit class, that is returned
6842 * without any further consideration.
6843 *
6844 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6845 * category to be considered.
6846 *
6847 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6848 * action.
6849 *
6850 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6851 * this type.
6852 *
6853 * <p>If {@link #addCategory} has added any categories, the activity must
6854 * handle ALL of the categories specified.
6855 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006856 * <p>If {@link #getPackage} is non-NULL, only activity components in
6857 * that application package will be considered.
6858 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006859 * <p>If there are no activities that satisfy all of these conditions, a
6860 * null string is returned.
6861 *
6862 * <p>If multiple activities are found to satisfy the intent, the one with
6863 * the highest priority will be used. If there are multiple activities
6864 * with the same priority, the system will either pick the best activity
6865 * based on user preference, or resolve to a system class that will allow
6866 * the user to pick an activity and forward from there.
6867 *
6868 * <p>This method is implemented simply by calling
6869 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6870 * true.</p>
6871 * <p> This API is called for you as part of starting an activity from an
6872 * intent. You do not normally need to call it yourself.</p>
6873 *
6874 * @param pm The package manager with which to resolve the Intent.
6875 *
6876 * @return Name of the component implementing an activity that can
6877 * display the intent.
6878 *
6879 * @see #setComponent
6880 * @see #getComponent
6881 * @see #resolveActivityInfo
6882 */
6883 public ComponentName resolveActivity(PackageManager pm) {
6884 if (mComponent != null) {
6885 return mComponent;
6886 }
6887
6888 ResolveInfo info = pm.resolveActivity(
6889 this, PackageManager.MATCH_DEFAULT_ONLY);
6890 if (info != null) {
6891 return new ComponentName(
6892 info.activityInfo.applicationInfo.packageName,
6893 info.activityInfo.name);
6894 }
6895
6896 return null;
6897 }
6898
6899 /**
6900 * Resolve the Intent into an {@link ActivityInfo}
6901 * describing the activity that should execute the intent. Resolution
6902 * follows the same rules as described for {@link #resolveActivity}, but
6903 * you get back the completely information about the resolved activity
6904 * instead of just its class name.
6905 *
6906 * @param pm The package manager with which to resolve the Intent.
6907 * @param flags Addition information to retrieve as per
6908 * {@link PackageManager#getActivityInfo(ComponentName, int)
6909 * PackageManager.getActivityInfo()}.
6910 *
6911 * @return PackageManager.ActivityInfo
6912 *
6913 * @see #resolveActivity
6914 */
6915 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6916 ActivityInfo ai = null;
6917 if (mComponent != null) {
6918 try {
6919 ai = pm.getActivityInfo(mComponent, flags);
6920 } catch (PackageManager.NameNotFoundException e) {
6921 // ignore
6922 }
6923 } else {
6924 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006925 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006926 if (info != null) {
6927 ai = info.activityInfo;
6928 }
6929 }
6930
6931 return ai;
6932 }
6933
6934 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006935 * Special function for use by the system to resolve service
6936 * intents to system apps. Throws an exception if there are
6937 * multiple potential matches to the Intent. Returns null if
6938 * there are no matches.
6939 * @hide
6940 */
6941 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6942 if (mComponent != null) {
6943 return mComponent;
6944 }
6945
6946 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6947 if (results == null) {
6948 return null;
6949 }
6950 ComponentName comp = null;
6951 for (int i=0; i<results.size(); i++) {
6952 ResolveInfo ri = results.get(i);
6953 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6954 continue;
6955 }
6956 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6957 ri.serviceInfo.name);
6958 if (comp != null) {
6959 throw new IllegalStateException("Multiple system services handle " + this
6960 + ": " + comp + ", " + foundComp);
6961 }
6962 comp = foundComp;
6963 }
6964 return comp;
6965 }
6966
6967 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006968 * Set the general action to be performed.
6969 *
6970 * @param action An action name, such as ACTION_VIEW. Application-specific
6971 * actions should be prefixed with the vendor's package name.
6972 *
6973 * @return Returns the same Intent object, for chaining multiple calls
6974 * into a single statement.
6975 *
6976 * @see #getAction
6977 */
6978 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006979 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006980 return this;
6981 }
6982
6983 /**
6984 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006985 * clears any type that was previously set by {@link #setType} or
6986 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006987 *
Nick Pellyccae4122012-01-09 14:12:58 -08006988 * <p><em>Note: scheme matching in the Android framework is
6989 * case-sensitive, unlike the formal RFC. As a result,
6990 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006991 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006992 * {@link #setDataAndNormalize}
6993 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006994 *
Nick Pellyccae4122012-01-09 14:12:58 -08006995 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006996 *
6997 * @return Returns the same Intent object, for chaining multiple calls
6998 * into a single statement.
6999 *
7000 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007001 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007002 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007003 */
7004 public Intent setData(Uri data) {
7005 mData = data;
7006 mType = null;
7007 return this;
7008 }
7009
7010 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007011 * Normalize and set the data this intent is operating on.
7012 *
7013 * <p>This method automatically clears any type that was
7014 * previously set (for example, by {@link #setType}).
7015 *
7016 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007017 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007018 * so really this is just a convenience method for
7019 * <pre>
7020 * setData(data.normalize())
7021 * </pre>
7022 *
7023 * @param data The Uri of the data this intent is now targeting.
7024 *
7025 * @return Returns the same Intent object, for chaining multiple calls
7026 * into a single statement.
7027 *
7028 * @see #getData
7029 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007030 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007031 */
7032 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007033 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007034 }
7035
7036 /**
7037 * Set an explicit MIME data type.
7038 *
7039 * <p>This is used to create intents that only specify a type and not data,
7040 * for example to indicate the type of data to return.
7041 *
7042 * <p>This method automatically clears any data that was
7043 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007044 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007045 * <p><em>Note: MIME type matching in the Android framework is
7046 * case-sensitive, unlike formal RFC MIME types. As a result,
7047 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007048 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7049 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007050 *
7051 * @param type The MIME type of the data being handled by this intent.
7052 *
7053 * @return Returns the same Intent object, for chaining multiple calls
7054 * into a single statement.
7055 *
7056 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007057 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007058 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007059 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007060 */
7061 public Intent setType(String type) {
7062 mData = null;
7063 mType = type;
7064 return this;
7065 }
7066
7067 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007068 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007069 *
Nick Pellyccae4122012-01-09 14:12:58 -08007070 * <p>This is used to create intents that only specify a type and not data,
7071 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007072 *
Nick Pellyccae4122012-01-09 14:12:58 -08007073 * <p>This method automatically clears any data that was
7074 * previously set (for example by {@link #setData}).
7075 *
7076 * <p>The MIME type is normalized using
7077 * {@link #normalizeMimeType} before it is set,
7078 * so really this is just a convenience method for
7079 * <pre>
7080 * setType(Intent.normalizeMimeType(type))
7081 * </pre>
7082 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007083 * @param type The MIME type of the data being handled by this intent.
7084 *
7085 * @return Returns the same Intent object, for chaining multiple calls
7086 * into a single statement.
7087 *
Nick Pellyccae4122012-01-09 14:12:58 -08007088 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007089 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007090 * @see #normalizeMimeType
7091 */
7092 public Intent setTypeAndNormalize(String type) {
7093 return setType(normalizeMimeType(type));
7094 }
7095
7096 /**
7097 * (Usually optional) Set the data for the intent along with an explicit
7098 * MIME data type. This method should very rarely be used -- it allows you
7099 * to override the MIME type that would ordinarily be inferred from the
7100 * data with your own type given here.
7101 *
7102 * <p><em>Note: MIME type and Uri scheme matching in the
7103 * Android framework is case-sensitive, unlike the formal RFC definitions.
7104 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007105 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007106 * {@link #setDataAndTypeAndNormalize}
7107 * to ensure that they are converted to lower case.</em>
7108 *
7109 * @param data The Uri of the data this intent is now targeting.
7110 * @param type The MIME type of the data being handled by this intent.
7111 *
7112 * @return Returns the same Intent object, for chaining multiple calls
7113 * into a single statement.
7114 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007115 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007116 * @see #setData
7117 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007118 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007119 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007120 */
7121 public Intent setDataAndType(Uri data, String type) {
7122 mData = data;
7123 mType = type;
7124 return this;
7125 }
7126
7127 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007128 * (Usually optional) Normalize and set both the data Uri and an explicit
7129 * MIME data type. This method should very rarely be used -- it allows you
7130 * to override the MIME type that would ordinarily be inferred from the
7131 * data with your own type given here.
7132 *
7133 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007134 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007135 * before they are set, so really this is just a convenience method for
7136 * <pre>
7137 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7138 * </pre>
7139 *
7140 * @param data The Uri of the data this intent is now targeting.
7141 * @param type The MIME type of the data being handled by this intent.
7142 *
7143 * @return Returns the same Intent object, for chaining multiple calls
7144 * into a single statement.
7145 *
7146 * @see #setType
7147 * @see #setData
7148 * @see #setDataAndType
7149 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007150 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007151 */
7152 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007153 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007154 }
7155
7156 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007157 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007158 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007159 * activities that provide <em>all</em> of the requested categories will be
7160 * used.
7161 *
7162 * @param category The desired category. This can be either one of the
7163 * predefined Intent categories, or a custom category in your own
7164 * namespace.
7165 *
7166 * @return Returns the same Intent object, for chaining multiple calls
7167 * into a single statement.
7168 *
7169 * @see #hasCategory
7170 * @see #removeCategory
7171 */
7172 public Intent addCategory(String category) {
7173 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007174 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007175 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007176 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007177 return this;
7178 }
7179
7180 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007181 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007182 *
7183 * @param category The category to remove.
7184 *
7185 * @see #addCategory
7186 */
7187 public void removeCategory(String category) {
7188 if (mCategories != null) {
7189 mCategories.remove(category);
7190 if (mCategories.size() == 0) {
7191 mCategories = null;
7192 }
7193 }
7194 }
7195
7196 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007197 * Set a selector for this Intent. This is a modification to the kinds of
7198 * things the Intent will match. If the selector is set, it will be used
7199 * when trying to find entities that can handle the Intent, instead of the
7200 * main contents of the Intent. This allows you build an Intent containing
7201 * a generic protocol while targeting it more specifically.
7202 *
7203 * <p>An example of where this may be used is with things like
7204 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7205 * Intent that will launch the Browser application. However, the correct
7206 * main entry point of an application is actually {@link #ACTION_MAIN}
7207 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7208 * used to specify the actual Activity to launch. If you launch the browser
7209 * with something different, undesired behavior may happen if the user has
7210 * previously or later launches it the normal way, since they do not match.
7211 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7212 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7213 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7214 *
7215 * <p>Setting a selector does not impact the behavior of
7216 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7217 * desired behavior of a selector -- it does not impact the base meaning
7218 * of the Intent, just what kinds of things will be matched against it
7219 * when determining who can handle it.</p>
7220 *
7221 * <p>You can not use both a selector and {@link #setPackage(String)} on
7222 * the same base Intent.</p>
7223 *
7224 * @param selector The desired selector Intent; set to null to not use
7225 * a special selector.
7226 */
7227 public void setSelector(Intent selector) {
7228 if (selector == this) {
7229 throw new IllegalArgumentException(
7230 "Intent being set as a selector of itself");
7231 }
7232 if (selector != null && mPackage != null) {
7233 throw new IllegalArgumentException(
7234 "Can't set selector when package name is already set");
7235 }
7236 mSelector = selector;
7237 }
7238
7239 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007240 * Set a {@link ClipData} associated with this Intent. This replaces any
7241 * previously set ClipData.
7242 *
7243 * <p>The ClipData in an intent is not used for Intent matching or other
7244 * such operations. Semantically it is like extras, used to transmit
7245 * additional data with the Intent. The main feature of using this over
7246 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7247 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7248 * items included in the clip data. This is useful, in particular, if
7249 * you want to transmit an Intent containing multiple <code>content:</code>
7250 * URIs for which the recipient may not have global permission to access the
7251 * content provider.
7252 *
7253 * <p>If the ClipData contains items that are themselves Intents, any
7254 * grant flags in those Intents will be ignored. Only the top-level flags
7255 * of the main Intent are respected, and will be applied to all Uri or
7256 * Intent items in the clip (or sub-items of the clip).
7257 *
7258 * <p>The MIME type, label, and icon in the ClipData object are not
7259 * directly used by Intent. Applications should generally rely on the
7260 * MIME type of the Intent itself, not what it may find in the ClipData.
7261 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007262 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007263 *
7264 * @param clip The new clip to set. May be null to clear the current clip.
7265 */
7266 public void setClipData(ClipData clip) {
7267 mClipData = clip;
7268 }
7269
7270 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007271 * This is NOT a secure mechanism to identify the user who sent the intent.
7272 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7273 * who sent the intent.
7274 * @hide
7275 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007276 public void prepareToLeaveUser(int userId) {
7277 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7278 // We want mContentUserHint to refer to the original user, so don't do anything.
7279 if (mContentUserHint == UserHandle.USER_CURRENT) {
7280 mContentUserHint = userId;
7281 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007282 }
7283
7284 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007285 * Add extended data to the intent. The name must include a package
7286 * prefix, for example the app com.android.contacts would use names
7287 * like "com.android.contacts.ShowAll".
7288 *
7289 * @param name The name of the extra data, with package prefix.
7290 * @param value The boolean data value.
7291 *
7292 * @return Returns the same Intent object, for chaining multiple calls
7293 * into a single statement.
7294 *
7295 * @see #putExtras
7296 * @see #removeExtra
7297 * @see #getBooleanExtra(String, boolean)
7298 */
7299 public Intent putExtra(String name, boolean value) {
7300 if (mExtras == null) {
7301 mExtras = new Bundle();
7302 }
7303 mExtras.putBoolean(name, value);
7304 return this;
7305 }
7306
7307 /**
7308 * Add extended data to the intent. The name must include a package
7309 * prefix, for example the app com.android.contacts would use names
7310 * like "com.android.contacts.ShowAll".
7311 *
7312 * @param name The name of the extra data, with package prefix.
7313 * @param value The byte data value.
7314 *
7315 * @return Returns the same Intent object, for chaining multiple calls
7316 * into a single statement.
7317 *
7318 * @see #putExtras
7319 * @see #removeExtra
7320 * @see #getByteExtra(String, byte)
7321 */
7322 public Intent putExtra(String name, byte value) {
7323 if (mExtras == null) {
7324 mExtras = new Bundle();
7325 }
7326 mExtras.putByte(name, value);
7327 return this;
7328 }
7329
7330 /**
7331 * Add extended data to the intent. The name must include a package
7332 * prefix, for example the app com.android.contacts would use names
7333 * like "com.android.contacts.ShowAll".
7334 *
7335 * @param name The name of the extra data, with package prefix.
7336 * @param value The char data value.
7337 *
7338 * @return Returns the same Intent object, for chaining multiple calls
7339 * into a single statement.
7340 *
7341 * @see #putExtras
7342 * @see #removeExtra
7343 * @see #getCharExtra(String, char)
7344 */
7345 public Intent putExtra(String name, char value) {
7346 if (mExtras == null) {
7347 mExtras = new Bundle();
7348 }
7349 mExtras.putChar(name, value);
7350 return this;
7351 }
7352
7353 /**
7354 * Add extended data to the intent. The name must include a package
7355 * prefix, for example the app com.android.contacts would use names
7356 * like "com.android.contacts.ShowAll".
7357 *
7358 * @param name The name of the extra data, with package prefix.
7359 * @param value The short data value.
7360 *
7361 * @return Returns the same Intent object, for chaining multiple calls
7362 * into a single statement.
7363 *
7364 * @see #putExtras
7365 * @see #removeExtra
7366 * @see #getShortExtra(String, short)
7367 */
7368 public Intent putExtra(String name, short value) {
7369 if (mExtras == null) {
7370 mExtras = new Bundle();
7371 }
7372 mExtras.putShort(name, value);
7373 return this;
7374 }
7375
7376 /**
7377 * Add extended data to the intent. The name must include a package
7378 * prefix, for example the app com.android.contacts would use names
7379 * like "com.android.contacts.ShowAll".
7380 *
7381 * @param name The name of the extra data, with package prefix.
7382 * @param value The integer data value.
7383 *
7384 * @return Returns the same Intent object, for chaining multiple calls
7385 * into a single statement.
7386 *
7387 * @see #putExtras
7388 * @see #removeExtra
7389 * @see #getIntExtra(String, int)
7390 */
7391 public Intent putExtra(String name, int value) {
7392 if (mExtras == null) {
7393 mExtras = new Bundle();
7394 }
7395 mExtras.putInt(name, value);
7396 return this;
7397 }
7398
7399 /**
7400 * Add extended data to the intent. The name must include a package
7401 * prefix, for example the app com.android.contacts would use names
7402 * like "com.android.contacts.ShowAll".
7403 *
7404 * @param name The name of the extra data, with package prefix.
7405 * @param value The long data value.
7406 *
7407 * @return Returns the same Intent object, for chaining multiple calls
7408 * into a single statement.
7409 *
7410 * @see #putExtras
7411 * @see #removeExtra
7412 * @see #getLongExtra(String, long)
7413 */
7414 public Intent putExtra(String name, long value) {
7415 if (mExtras == null) {
7416 mExtras = new Bundle();
7417 }
7418 mExtras.putLong(name, value);
7419 return this;
7420 }
7421
7422 /**
7423 * Add extended data to the intent. The name must include a package
7424 * prefix, for example the app com.android.contacts would use names
7425 * like "com.android.contacts.ShowAll".
7426 *
7427 * @param name The name of the extra data, with package prefix.
7428 * @param value The float data value.
7429 *
7430 * @return Returns the same Intent object, for chaining multiple calls
7431 * into a single statement.
7432 *
7433 * @see #putExtras
7434 * @see #removeExtra
7435 * @see #getFloatExtra(String, float)
7436 */
7437 public Intent putExtra(String name, float value) {
7438 if (mExtras == null) {
7439 mExtras = new Bundle();
7440 }
7441 mExtras.putFloat(name, value);
7442 return this;
7443 }
7444
7445 /**
7446 * Add extended data to the intent. The name must include a package
7447 * prefix, for example the app com.android.contacts would use names
7448 * like "com.android.contacts.ShowAll".
7449 *
7450 * @param name The name of the extra data, with package prefix.
7451 * @param value The double data value.
7452 *
7453 * @return Returns the same Intent object, for chaining multiple calls
7454 * into a single statement.
7455 *
7456 * @see #putExtras
7457 * @see #removeExtra
7458 * @see #getDoubleExtra(String, double)
7459 */
7460 public Intent putExtra(String name, double value) {
7461 if (mExtras == null) {
7462 mExtras = new Bundle();
7463 }
7464 mExtras.putDouble(name, value);
7465 return this;
7466 }
7467
7468 /**
7469 * Add extended data to the intent. The name must include a package
7470 * prefix, for example the app com.android.contacts would use names
7471 * like "com.android.contacts.ShowAll".
7472 *
7473 * @param name The name of the extra data, with package prefix.
7474 * @param value The String data value.
7475 *
7476 * @return Returns the same Intent object, for chaining multiple calls
7477 * into a single statement.
7478 *
7479 * @see #putExtras
7480 * @see #removeExtra
7481 * @see #getStringExtra(String)
7482 */
7483 public Intent putExtra(String name, String value) {
7484 if (mExtras == null) {
7485 mExtras = new Bundle();
7486 }
7487 mExtras.putString(name, value);
7488 return this;
7489 }
7490
7491 /**
7492 * Add extended data to the intent. The name must include a package
7493 * prefix, for example the app com.android.contacts would use names
7494 * like "com.android.contacts.ShowAll".
7495 *
7496 * @param name The name of the extra data, with package prefix.
7497 * @param value The CharSequence data value.
7498 *
7499 * @return Returns the same Intent object, for chaining multiple calls
7500 * into a single statement.
7501 *
7502 * @see #putExtras
7503 * @see #removeExtra
7504 * @see #getCharSequenceExtra(String)
7505 */
7506 public Intent putExtra(String name, CharSequence value) {
7507 if (mExtras == null) {
7508 mExtras = new Bundle();
7509 }
7510 mExtras.putCharSequence(name, value);
7511 return this;
7512 }
7513
7514 /**
7515 * Add extended data to the intent. The name must include a package
7516 * prefix, for example the app com.android.contacts would use names
7517 * like "com.android.contacts.ShowAll".
7518 *
7519 * @param name The name of the extra data, with package prefix.
7520 * @param value The Parcelable data value.
7521 *
7522 * @return Returns the same Intent object, for chaining multiple calls
7523 * into a single statement.
7524 *
7525 * @see #putExtras
7526 * @see #removeExtra
7527 * @see #getParcelableExtra(String)
7528 */
7529 public Intent putExtra(String name, Parcelable value) {
7530 if (mExtras == null) {
7531 mExtras = new Bundle();
7532 }
7533 mExtras.putParcelable(name, value);
7534 return this;
7535 }
7536
7537 /**
7538 * Add extended data to the intent. The name must include a package
7539 * prefix, for example the app com.android.contacts would use names
7540 * like "com.android.contacts.ShowAll".
7541 *
7542 * @param name The name of the extra data, with package prefix.
7543 * @param value The Parcelable[] data value.
7544 *
7545 * @return Returns the same Intent object, for chaining multiple calls
7546 * into a single statement.
7547 *
7548 * @see #putExtras
7549 * @see #removeExtra
7550 * @see #getParcelableArrayExtra(String)
7551 */
7552 public Intent putExtra(String name, Parcelable[] value) {
7553 if (mExtras == null) {
7554 mExtras = new Bundle();
7555 }
7556 mExtras.putParcelableArray(name, value);
7557 return this;
7558 }
7559
7560 /**
7561 * Add extended data to the intent. The name must include a package
7562 * prefix, for example the app com.android.contacts would use names
7563 * like "com.android.contacts.ShowAll".
7564 *
7565 * @param name The name of the extra data, with package prefix.
7566 * @param value The ArrayList<Parcelable> data value.
7567 *
7568 * @return Returns the same Intent object, for chaining multiple calls
7569 * into a single statement.
7570 *
7571 * @see #putExtras
7572 * @see #removeExtra
7573 * @see #getParcelableArrayListExtra(String)
7574 */
7575 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7576 if (mExtras == null) {
7577 mExtras = new Bundle();
7578 }
7579 mExtras.putParcelableArrayList(name, value);
7580 return this;
7581 }
7582
7583 /**
7584 * Add extended data to the intent. The name must include a package
7585 * prefix, for example the app com.android.contacts would use names
7586 * like "com.android.contacts.ShowAll".
7587 *
7588 * @param name The name of the extra data, with package prefix.
7589 * @param value The ArrayList<Integer> data value.
7590 *
7591 * @return Returns the same Intent object, for chaining multiple calls
7592 * into a single statement.
7593 *
7594 * @see #putExtras
7595 * @see #removeExtra
7596 * @see #getIntegerArrayListExtra(String)
7597 */
7598 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7599 if (mExtras == null) {
7600 mExtras = new Bundle();
7601 }
7602 mExtras.putIntegerArrayList(name, value);
7603 return this;
7604 }
7605
7606 /**
7607 * Add extended data to the intent. The name must include a package
7608 * prefix, for example the app com.android.contacts would use names
7609 * like "com.android.contacts.ShowAll".
7610 *
7611 * @param name The name of the extra data, with package prefix.
7612 * @param value The ArrayList<String> data value.
7613 *
7614 * @return Returns the same Intent object, for chaining multiple calls
7615 * into a single statement.
7616 *
7617 * @see #putExtras
7618 * @see #removeExtra
7619 * @see #getStringArrayListExtra(String)
7620 */
7621 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7622 if (mExtras == null) {
7623 mExtras = new Bundle();
7624 }
7625 mExtras.putStringArrayList(name, value);
7626 return this;
7627 }
7628
7629 /**
7630 * Add extended data to the intent. The name must include a package
7631 * prefix, for example the app com.android.contacts would use names
7632 * like "com.android.contacts.ShowAll".
7633 *
7634 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007635 * @param value The ArrayList<CharSequence> data value.
7636 *
7637 * @return Returns the same Intent object, for chaining multiple calls
7638 * into a single statement.
7639 *
7640 * @see #putExtras
7641 * @see #removeExtra
7642 * @see #getCharSequenceArrayListExtra(String)
7643 */
7644 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7645 if (mExtras == null) {
7646 mExtras = new Bundle();
7647 }
7648 mExtras.putCharSequenceArrayList(name, value);
7649 return this;
7650 }
7651
7652 /**
7653 * Add extended data to the intent. The name must include a package
7654 * prefix, for example the app com.android.contacts would use names
7655 * like "com.android.contacts.ShowAll".
7656 *
7657 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007658 * @param value The Serializable data value.
7659 *
7660 * @return Returns the same Intent object, for chaining multiple calls
7661 * into a single statement.
7662 *
7663 * @see #putExtras
7664 * @see #removeExtra
7665 * @see #getSerializableExtra(String)
7666 */
7667 public Intent putExtra(String name, Serializable value) {
7668 if (mExtras == null) {
7669 mExtras = new Bundle();
7670 }
7671 mExtras.putSerializable(name, value);
7672 return this;
7673 }
7674
7675 /**
7676 * Add extended data to the intent. The name must include a package
7677 * prefix, for example the app com.android.contacts would use names
7678 * like "com.android.contacts.ShowAll".
7679 *
7680 * @param name The name of the extra data, with package prefix.
7681 * @param value The boolean array data value.
7682 *
7683 * @return Returns the same Intent object, for chaining multiple calls
7684 * into a single statement.
7685 *
7686 * @see #putExtras
7687 * @see #removeExtra
7688 * @see #getBooleanArrayExtra(String)
7689 */
7690 public Intent putExtra(String name, boolean[] value) {
7691 if (mExtras == null) {
7692 mExtras = new Bundle();
7693 }
7694 mExtras.putBooleanArray(name, value);
7695 return this;
7696 }
7697
7698 /**
7699 * Add extended data to the intent. The name must include a package
7700 * prefix, for example the app com.android.contacts would use names
7701 * like "com.android.contacts.ShowAll".
7702 *
7703 * @param name The name of the extra data, with package prefix.
7704 * @param value The byte array data value.
7705 *
7706 * @return Returns the same Intent object, for chaining multiple calls
7707 * into a single statement.
7708 *
7709 * @see #putExtras
7710 * @see #removeExtra
7711 * @see #getByteArrayExtra(String)
7712 */
7713 public Intent putExtra(String name, byte[] value) {
7714 if (mExtras == null) {
7715 mExtras = new Bundle();
7716 }
7717 mExtras.putByteArray(name, value);
7718 return this;
7719 }
7720
7721 /**
7722 * Add extended data to the intent. The name must include a package
7723 * prefix, for example the app com.android.contacts would use names
7724 * like "com.android.contacts.ShowAll".
7725 *
7726 * @param name The name of the extra data, with package prefix.
7727 * @param value The short array data value.
7728 *
7729 * @return Returns the same Intent object, for chaining multiple calls
7730 * into a single statement.
7731 *
7732 * @see #putExtras
7733 * @see #removeExtra
7734 * @see #getShortArrayExtra(String)
7735 */
7736 public Intent putExtra(String name, short[] value) {
7737 if (mExtras == null) {
7738 mExtras = new Bundle();
7739 }
7740 mExtras.putShortArray(name, value);
7741 return this;
7742 }
7743
7744 /**
7745 * Add extended data to the intent. The name must include a package
7746 * prefix, for example the app com.android.contacts would use names
7747 * like "com.android.contacts.ShowAll".
7748 *
7749 * @param name The name of the extra data, with package prefix.
7750 * @param value The char array data value.
7751 *
7752 * @return Returns the same Intent object, for chaining multiple calls
7753 * into a single statement.
7754 *
7755 * @see #putExtras
7756 * @see #removeExtra
7757 * @see #getCharArrayExtra(String)
7758 */
7759 public Intent putExtra(String name, char[] value) {
7760 if (mExtras == null) {
7761 mExtras = new Bundle();
7762 }
7763 mExtras.putCharArray(name, value);
7764 return this;
7765 }
7766
7767 /**
7768 * Add extended data to the intent. The name must include a package
7769 * prefix, for example the app com.android.contacts would use names
7770 * like "com.android.contacts.ShowAll".
7771 *
7772 * @param name The name of the extra data, with package prefix.
7773 * @param value The int array data value.
7774 *
7775 * @return Returns the same Intent object, for chaining multiple calls
7776 * into a single statement.
7777 *
7778 * @see #putExtras
7779 * @see #removeExtra
7780 * @see #getIntArrayExtra(String)
7781 */
7782 public Intent putExtra(String name, int[] value) {
7783 if (mExtras == null) {
7784 mExtras = new Bundle();
7785 }
7786 mExtras.putIntArray(name, value);
7787 return this;
7788 }
7789
7790 /**
7791 * Add extended data to the intent. The name must include a package
7792 * prefix, for example the app com.android.contacts would use names
7793 * like "com.android.contacts.ShowAll".
7794 *
7795 * @param name The name of the extra data, with package prefix.
7796 * @param value The byte array data value.
7797 *
7798 * @return Returns the same Intent object, for chaining multiple calls
7799 * into a single statement.
7800 *
7801 * @see #putExtras
7802 * @see #removeExtra
7803 * @see #getLongArrayExtra(String)
7804 */
7805 public Intent putExtra(String name, long[] value) {
7806 if (mExtras == null) {
7807 mExtras = new Bundle();
7808 }
7809 mExtras.putLongArray(name, value);
7810 return this;
7811 }
7812
7813 /**
7814 * Add extended data to the intent. The name must include a package
7815 * prefix, for example the app com.android.contacts would use names
7816 * like "com.android.contacts.ShowAll".
7817 *
7818 * @param name The name of the extra data, with package prefix.
7819 * @param value The float array data value.
7820 *
7821 * @return Returns the same Intent object, for chaining multiple calls
7822 * into a single statement.
7823 *
7824 * @see #putExtras
7825 * @see #removeExtra
7826 * @see #getFloatArrayExtra(String)
7827 */
7828 public Intent putExtra(String name, float[] value) {
7829 if (mExtras == null) {
7830 mExtras = new Bundle();
7831 }
7832 mExtras.putFloatArray(name, value);
7833 return this;
7834 }
7835
7836 /**
7837 * Add extended data to the intent. The name must include a package
7838 * prefix, for example the app com.android.contacts would use names
7839 * like "com.android.contacts.ShowAll".
7840 *
7841 * @param name The name of the extra data, with package prefix.
7842 * @param value The double array data value.
7843 *
7844 * @return Returns the same Intent object, for chaining multiple calls
7845 * into a single statement.
7846 *
7847 * @see #putExtras
7848 * @see #removeExtra
7849 * @see #getDoubleArrayExtra(String)
7850 */
7851 public Intent putExtra(String name, double[] value) {
7852 if (mExtras == null) {
7853 mExtras = new Bundle();
7854 }
7855 mExtras.putDoubleArray(name, value);
7856 return this;
7857 }
7858
7859 /**
7860 * Add extended data to the intent. The name must include a package
7861 * prefix, for example the app com.android.contacts would use names
7862 * like "com.android.contacts.ShowAll".
7863 *
7864 * @param name The name of the extra data, with package prefix.
7865 * @param value The String array data value.
7866 *
7867 * @return Returns the same Intent object, for chaining multiple calls
7868 * into a single statement.
7869 *
7870 * @see #putExtras
7871 * @see #removeExtra
7872 * @see #getStringArrayExtra(String)
7873 */
7874 public Intent putExtra(String name, String[] value) {
7875 if (mExtras == null) {
7876 mExtras = new Bundle();
7877 }
7878 mExtras.putStringArray(name, value);
7879 return this;
7880 }
7881
7882 /**
7883 * Add extended data to the intent. The name must include a package
7884 * prefix, for example the app com.android.contacts would use names
7885 * like "com.android.contacts.ShowAll".
7886 *
7887 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007888 * @param value The CharSequence array data value.
7889 *
7890 * @return Returns the same Intent object, for chaining multiple calls
7891 * into a single statement.
7892 *
7893 * @see #putExtras
7894 * @see #removeExtra
7895 * @see #getCharSequenceArrayExtra(String)
7896 */
7897 public Intent putExtra(String name, CharSequence[] value) {
7898 if (mExtras == null) {
7899 mExtras = new Bundle();
7900 }
7901 mExtras.putCharSequenceArray(name, value);
7902 return this;
7903 }
7904
7905 /**
7906 * Add extended data to the intent. The name must include a package
7907 * prefix, for example the app com.android.contacts would use names
7908 * like "com.android.contacts.ShowAll".
7909 *
7910 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007911 * @param value The Bundle data value.
7912 *
7913 * @return Returns the same Intent object, for chaining multiple calls
7914 * into a single statement.
7915 *
7916 * @see #putExtras
7917 * @see #removeExtra
7918 * @see #getBundleExtra(String)
7919 */
7920 public Intent putExtra(String name, Bundle value) {
7921 if (mExtras == null) {
7922 mExtras = new Bundle();
7923 }
7924 mExtras.putBundle(name, value);
7925 return this;
7926 }
7927
7928 /**
7929 * Add extended data to the intent. The name must include a package
7930 * prefix, for example the app com.android.contacts would use names
7931 * like "com.android.contacts.ShowAll".
7932 *
7933 * @param name The name of the extra data, with package prefix.
7934 * @param value The IBinder data value.
7935 *
7936 * @return Returns the same Intent object, for chaining multiple calls
7937 * into a single statement.
7938 *
7939 * @see #putExtras
7940 * @see #removeExtra
7941 * @see #getIBinderExtra(String)
7942 *
7943 * @deprecated
7944 * @hide
7945 */
7946 @Deprecated
7947 public Intent putExtra(String name, IBinder value) {
7948 if (mExtras == null) {
7949 mExtras = new Bundle();
7950 }
7951 mExtras.putIBinder(name, value);
7952 return this;
7953 }
7954
7955 /**
7956 * Copy all extras in 'src' in to this intent.
7957 *
7958 * @param src Contains the extras to copy.
7959 *
7960 * @see #putExtra
7961 */
7962 public Intent putExtras(Intent src) {
7963 if (src.mExtras != null) {
7964 if (mExtras == null) {
7965 mExtras = new Bundle(src.mExtras);
7966 } else {
7967 mExtras.putAll(src.mExtras);
7968 }
7969 }
7970 return this;
7971 }
7972
7973 /**
7974 * Add a set of extended data to the intent. The keys must include a package
7975 * prefix, for example the app com.android.contacts would use names
7976 * like "com.android.contacts.ShowAll".
7977 *
7978 * @param extras The Bundle of extras to add to this intent.
7979 *
7980 * @see #putExtra
7981 * @see #removeExtra
7982 */
7983 public Intent putExtras(Bundle extras) {
7984 if (mExtras == null) {
7985 mExtras = new Bundle();
7986 }
7987 mExtras.putAll(extras);
7988 return this;
7989 }
7990
7991 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007992 * Completely replace the extras in the Intent with the extras in the
7993 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007994 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007995 * @param src The exact extras contained in this Intent are copied
7996 * into the target intent, replacing any that were previously there.
7997 */
7998 public Intent replaceExtras(Intent src) {
7999 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8000 return this;
8001 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008002
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008003 /**
8004 * Completely replace the extras in the Intent with the given Bundle of
8005 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008006 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008007 * @param extras The new set of extras in the Intent, or null to erase
8008 * all extras.
8009 */
8010 public Intent replaceExtras(Bundle extras) {
8011 mExtras = extras != null ? new Bundle(extras) : null;
8012 return this;
8013 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008014
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008016 * Remove extended data from the intent.
8017 *
8018 * @see #putExtra
8019 */
8020 public void removeExtra(String name) {
8021 if (mExtras != null) {
8022 mExtras.remove(name);
8023 if (mExtras.size() == 0) {
8024 mExtras = null;
8025 }
8026 }
8027 }
8028
8029 /**
8030 * Set special flags controlling how this intent is handled. Most values
8031 * here depend on the type of component being executed by the Intent,
8032 * specifically the FLAG_ACTIVITY_* flags are all for use with
8033 * {@link Context#startActivity Context.startActivity()} and the
8034 * FLAG_RECEIVER_* flags are all for use with
8035 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8036 *
Scott Main7aee61f2011-02-08 11:25:01 -08008037 * <p>See the
8038 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8039 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008040 * the behavior of your application.
8041 *
8042 * @param flags The desired flags.
8043 *
8044 * @return Returns the same Intent object, for chaining multiple calls
8045 * into a single statement.
8046 *
8047 * @see #getFlags
8048 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008049 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008050 *
8051 * @see #FLAG_GRANT_READ_URI_PERMISSION
8052 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07008053 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
8054 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008055 * @see #FLAG_DEBUG_LOG_RESOLUTION
8056 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008057 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008058 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008059 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008060 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008061 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
8062 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008063 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008064 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07008065 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008066 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008067 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008068 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08008069 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008070 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
8071 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008072 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008073 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008074 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008075 * @see #FLAG_RECEIVER_REGISTERED_ONLY
8076 */
8077 public Intent setFlags(int flags) {
8078 mFlags = flags;
8079 return this;
8080 }
8081
8082 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008083 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008084 *
8085 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008086 * @return Returns the same Intent object, for chaining multiple calls into
8087 * a single statement.
8088 * @see #setFlags(int)
8089 * @see #removeFlags(int)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008090 */
8091 public Intent addFlags(int flags) {
8092 mFlags |= flags;
8093 return this;
8094 }
8095
8096 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008097 * Remove these flags from the intent.
8098 *
8099 * @param flags The flags to remove.
8100 * @see #setFlags(int)
8101 * @see #addFlags(int)
8102 */
8103 public void removeFlags(int flags) {
8104 mFlags &= ~flags;
8105 }
8106
8107 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008108 * (Usually optional) Set an explicit application package name that limits
8109 * the components this Intent will resolve to. If left to the default
8110 * value of null, all components in all applications will considered.
8111 * If non-null, the Intent can only match the components in the given
8112 * application package.
8113 *
8114 * @param packageName The name of the application package to handle the
8115 * intent, or null to allow any application package.
8116 *
8117 * @return Returns the same Intent object, for chaining multiple calls
8118 * into a single statement.
8119 *
8120 * @see #getPackage
8121 * @see #resolveActivity
8122 */
8123 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008124 if (packageName != null && mSelector != null) {
8125 throw new IllegalArgumentException(
8126 "Can't set package name when selector is already set");
8127 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008128 mPackage = packageName;
8129 return this;
8130 }
8131
8132 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008133 * (Usually optional) Explicitly set the component to handle the intent.
8134 * If left with the default value of null, the system will determine the
8135 * appropriate class to use based on the other fields (action, data,
8136 * type, categories) in the Intent. If this class is defined, the
8137 * specified class will always be used regardless of the other fields. You
8138 * should only set this value when you know you absolutely want a specific
8139 * class to be used; otherwise it is better to let the system find the
8140 * appropriate class so that you will respect the installed applications
8141 * and user preferences.
8142 *
8143 * @param component The name of the application component to handle the
8144 * intent, or null to let the system find one for you.
8145 *
8146 * @return Returns the same Intent object, for chaining multiple calls
8147 * into a single statement.
8148 *
8149 * @see #setClass
8150 * @see #setClassName(Context, String)
8151 * @see #setClassName(String, String)
8152 * @see #getComponent
8153 * @see #resolveActivity
8154 */
8155 public Intent setComponent(ComponentName component) {
8156 mComponent = component;
8157 return this;
8158 }
8159
8160 /**
8161 * Convenience for calling {@link #setComponent} with an
8162 * explicit class name.
8163 *
8164 * @param packageContext A Context of the application package implementing
8165 * this class.
8166 * @param className The name of a class inside of the application package
8167 * that will be used as the component for this Intent.
8168 *
8169 * @return Returns the same Intent object, for chaining multiple calls
8170 * into a single statement.
8171 *
8172 * @see #setComponent
8173 * @see #setClass
8174 */
8175 public Intent setClassName(Context packageContext, String className) {
8176 mComponent = new ComponentName(packageContext, className);
8177 return this;
8178 }
8179
8180 /**
8181 * Convenience for calling {@link #setComponent} with an
8182 * explicit application package name and class name.
8183 *
8184 * @param packageName The name of the package implementing the desired
8185 * component.
8186 * @param className The name of a class inside of the application package
8187 * that will be used as the component for this Intent.
8188 *
8189 * @return Returns the same Intent object, for chaining multiple calls
8190 * into a single statement.
8191 *
8192 * @see #setComponent
8193 * @see #setClass
8194 */
8195 public Intent setClassName(String packageName, String className) {
8196 mComponent = new ComponentName(packageName, className);
8197 return this;
8198 }
8199
8200 /**
8201 * Convenience for calling {@link #setComponent(ComponentName)} with the
8202 * name returned by a {@link Class} object.
8203 *
8204 * @param packageContext A Context of the application package implementing
8205 * this class.
8206 * @param cls The class name to set, equivalent to
8207 * <code>setClassName(context, cls.getName())</code>.
8208 *
8209 * @return Returns the same Intent object, for chaining multiple calls
8210 * into a single statement.
8211 *
8212 * @see #setComponent
8213 */
8214 public Intent setClass(Context packageContext, Class<?> cls) {
8215 mComponent = new ComponentName(packageContext, cls);
8216 return this;
8217 }
8218
8219 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008220 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8221 * used as a hint to the receiver for animations and the like. Null means that there
8222 * is no source bounds.
8223 */
8224 public void setSourceBounds(Rect r) {
8225 if (r != null) {
8226 mSourceBounds = new Rect(r);
8227 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008228 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008229 }
8230 }
8231
Tor Norbyed9273d62013-05-30 15:59:53 -07008232 /** @hide */
8233 @IntDef(flag = true,
8234 value = {
8235 FILL_IN_ACTION,
8236 FILL_IN_DATA,
8237 FILL_IN_CATEGORIES,
8238 FILL_IN_COMPONENT,
8239 FILL_IN_PACKAGE,
8240 FILL_IN_SOURCE_BOUNDS,
8241 FILL_IN_SELECTOR,
8242 FILL_IN_CLIP_DATA
8243 })
8244 @Retention(RetentionPolicy.SOURCE)
8245 public @interface FillInFlags {}
8246
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008247 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008248 * Use with {@link #fillIn} to allow the current action value to be
8249 * overwritten, even if it is already set.
8250 */
8251 public static final int FILL_IN_ACTION = 1<<0;
8252
8253 /**
8254 * Use with {@link #fillIn} to allow the current data or type value
8255 * overwritten, even if it is already set.
8256 */
8257 public static final int FILL_IN_DATA = 1<<1;
8258
8259 /**
8260 * Use with {@link #fillIn} to allow the current categories to be
8261 * overwritten, even if they are already set.
8262 */
8263 public static final int FILL_IN_CATEGORIES = 1<<2;
8264
8265 /**
8266 * Use with {@link #fillIn} to allow the current component value to be
8267 * overwritten, even if it is already set.
8268 */
8269 public static final int FILL_IN_COMPONENT = 1<<3;
8270
8271 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008272 * Use with {@link #fillIn} to allow the current package value to be
8273 * overwritten, even if it is already set.
8274 */
8275 public static final int FILL_IN_PACKAGE = 1<<4;
8276
8277 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008278 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008279 * overwritten, even if it is already set.
8280 */
8281 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8282
8283 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008284 * Use with {@link #fillIn} to allow the current selector to be
8285 * overwritten, even if it is already set.
8286 */
8287 public static final int FILL_IN_SELECTOR = 1<<6;
8288
8289 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008290 * Use with {@link #fillIn} to allow the current ClipData to be
8291 * overwritten, even if it is already set.
8292 */
8293 public static final int FILL_IN_CLIP_DATA = 1<<7;
8294
8295 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008296 * Copy the contents of <var>other</var> in to this object, but only
8297 * where fields are not defined by this object. For purposes of a field
8298 * being defined, the following pieces of data in the Intent are
8299 * considered to be separate fields:
8300 *
8301 * <ul>
8302 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008303 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008304 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8305 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008306 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008307 * <li> component, as set by {@link #setComponent(ComponentName)} or
8308 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008309 * <li> source bounds, as set by {@link #setSourceBounds}.
8310 * <li> selector, as set by {@link #setSelector(Intent)}.
8311 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008312 * <li> each top-level name in the associated extras.
8313 * </ul>
8314 *
8315 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008316 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008317 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8318 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8319 * the restriction where the corresponding field will not be replaced if
8320 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008321 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008322 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8323 * is explicitly specified. The selector will only be copied if
8324 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008325 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008326 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8327 * and Intent B with {action="gotit", data-type="some/thing",
8328 * categories="one","two"}.
8329 *
8330 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8331 * containing: {action="gotit", data-type="some/thing",
8332 * categories="bar"}.
8333 *
8334 * @param other Another Intent whose values are to be used to fill in
8335 * the current one.
8336 * @param flags Options to control which fields can be filled in.
8337 *
8338 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008339 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008340 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8341 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8342 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008343 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008344 @FillInFlags
8345 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008346 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008347 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008348 if (other.mAction != null
8349 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008350 mAction = other.mAction;
8351 changes |= FILL_IN_ACTION;
8352 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008353 if ((other.mData != null || other.mType != null)
8354 && ((mData == null && mType == null)
8355 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008356 mData = other.mData;
8357 mType = other.mType;
8358 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008359 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008360 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008361 if (other.mCategories != null
8362 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008363 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008364 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008365 }
8366 changes |= FILL_IN_CATEGORIES;
8367 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008368 if (other.mPackage != null
8369 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008370 // Only do this if mSelector is not set.
8371 if (mSelector == null) {
8372 mPackage = other.mPackage;
8373 changes |= FILL_IN_PACKAGE;
8374 }
8375 }
8376 // Selector is special: it can only be set if explicitly allowed,
8377 // for the same reason as the component name.
8378 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8379 if (mPackage == null) {
8380 mSelector = new Intent(other.mSelector);
8381 mPackage = null;
8382 changes |= FILL_IN_SELECTOR;
8383 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008384 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008385 if (other.mClipData != null
8386 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8387 mClipData = other.mClipData;
8388 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008389 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008390 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008391 // Component is special: it can -only- be set if explicitly allowed,
8392 // since otherwise the sender could force the intent somewhere the
8393 // originator didn't intend.
8394 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008395 mComponent = other.mComponent;
8396 changes |= FILL_IN_COMPONENT;
8397 }
8398 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008399 if (other.mSourceBounds != null
8400 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8401 mSourceBounds = new Rect(other.mSourceBounds);
8402 changes |= FILL_IN_SOURCE_BOUNDS;
8403 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008404 if (mExtras == null) {
8405 if (other.mExtras != null) {
8406 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008407 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008408 }
8409 } else if (other.mExtras != null) {
8410 try {
8411 Bundle newb = new Bundle(other.mExtras);
8412 newb.putAll(mExtras);
8413 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008414 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008415 } catch (RuntimeException e) {
8416 // Modifying the extras can cause us to unparcel the contents
8417 // of the bundle, and if we do this in the system process that
8418 // may fail. We really should handle this (i.e., the Bundle
8419 // impl shouldn't be on top of a plain map), but for now just
8420 // ignore it and keep the original contents. :(
8421 Log.w("Intent", "Failure filling in extras", e);
8422 }
8423 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008424 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8425 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8426 mContentUserHint = other.mContentUserHint;
8427 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008428 return changes;
8429 }
8430
8431 /**
8432 * Wrapper class holding an Intent and implementing comparisons on it for
8433 * the purpose of filtering. The class implements its
8434 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8435 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8436 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8437 * on the wrapped Intent.
8438 */
8439 public static final class FilterComparison {
8440 private final Intent mIntent;
8441 private final int mHashCode;
8442
8443 public FilterComparison(Intent intent) {
8444 mIntent = intent;
8445 mHashCode = intent.filterHashCode();
8446 }
8447
8448 /**
8449 * Return the Intent that this FilterComparison represents.
8450 * @return Returns the Intent held by the FilterComparison. Do
8451 * not modify!
8452 */
8453 public Intent getIntent() {
8454 return mIntent;
8455 }
8456
8457 @Override
8458 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008459 if (obj instanceof FilterComparison) {
8460 Intent other = ((FilterComparison)obj).mIntent;
8461 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008462 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008463 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008464 }
8465
8466 @Override
8467 public int hashCode() {
8468 return mHashCode;
8469 }
8470 }
8471
8472 /**
8473 * Determine if two intents are the same for the purposes of intent
8474 * resolution (filtering). That is, if their action, data, type,
8475 * class, and categories are the same. This does <em>not</em> compare
8476 * any extra data included in the intents.
8477 *
8478 * @param other The other Intent to compare against.
8479 *
8480 * @return Returns true if action, data, type, class, and categories
8481 * are the same.
8482 */
8483 public boolean filterEquals(Intent other) {
8484 if (other == null) {
8485 return false;
8486 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008487 if (!Objects.equals(this.mAction, other.mAction)) return false;
8488 if (!Objects.equals(this.mData, other.mData)) return false;
8489 if (!Objects.equals(this.mType, other.mType)) return false;
8490 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8491 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8492 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008493
8494 return true;
8495 }
8496
8497 /**
8498 * Generate hash code that matches semantics of filterEquals().
8499 *
8500 * @return Returns the hash value of the action, data, type, class, and
8501 * categories.
8502 *
8503 * @see #filterEquals
8504 */
8505 public int filterHashCode() {
8506 int code = 0;
8507 if (mAction != null) {
8508 code += mAction.hashCode();
8509 }
8510 if (mData != null) {
8511 code += mData.hashCode();
8512 }
8513 if (mType != null) {
8514 code += mType.hashCode();
8515 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008516 if (mPackage != null) {
8517 code += mPackage.hashCode();
8518 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008519 if (mComponent != null) {
8520 code += mComponent.hashCode();
8521 }
8522 if (mCategories != null) {
8523 code += mCategories.hashCode();
8524 }
8525 return code;
8526 }
8527
8528 @Override
8529 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008530 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008531
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008532 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008533 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008534 b.append(" }");
8535
8536 return b.toString();
8537 }
8538
8539 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008540 public String toInsecureString() {
8541 StringBuilder b = new StringBuilder(128);
8542
8543 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008544 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008545 b.append(" }");
8546
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008547 return b.toString();
8548 }
Romain Guy4969af72009-06-17 10:53:19 -07008549
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008550 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008551 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008552 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008553
8554 b.append("Intent { ");
8555 toShortString(b, false, true, true, true);
8556 b.append(" }");
8557
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008558 return b.toString();
8559 }
8560
8561 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008562 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8563 StringBuilder b = new StringBuilder(128);
8564 toShortString(b, secure, comp, extras, clip);
8565 return b.toString();
8566 }
8567
8568 /** @hide */
8569 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8570 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008571 boolean first = true;
8572 if (mAction != null) {
8573 b.append("act=").append(mAction);
8574 first = false;
8575 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008576 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008577 if (!first) {
8578 b.append(' ');
8579 }
8580 first = false;
8581 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008582 for (int i=0; i<mCategories.size(); i++) {
8583 if (i > 0) b.append(',');
8584 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008585 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008586 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008587 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008588 if (mData != null) {
8589 if (!first) {
8590 b.append(' ');
8591 }
8592 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008593 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008594 if (secure) {
8595 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008596 } else {
8597 b.append(mData);
8598 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008599 }
8600 if (mType != null) {
8601 if (!first) {
8602 b.append(' ');
8603 }
8604 first = false;
8605 b.append("typ=").append(mType);
8606 }
8607 if (mFlags != 0) {
8608 if (!first) {
8609 b.append(' ');
8610 }
8611 first = false;
8612 b.append("flg=0x").append(Integer.toHexString(mFlags));
8613 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008614 if (mPackage != null) {
8615 if (!first) {
8616 b.append(' ');
8617 }
8618 first = false;
8619 b.append("pkg=").append(mPackage);
8620 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008621 if (comp && mComponent != null) {
8622 if (!first) {
8623 b.append(' ');
8624 }
8625 first = false;
8626 b.append("cmp=").append(mComponent.flattenToShortString());
8627 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008628 if (mSourceBounds != null) {
8629 if (!first) {
8630 b.append(' ');
8631 }
8632 first = false;
8633 b.append("bnds=").append(mSourceBounds.toShortString());
8634 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008635 if (mClipData != null) {
8636 if (!first) {
8637 b.append(' ');
8638 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008639 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008640 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008641 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008642 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008643 if (mClipData.getDescription() != null) {
8644 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8645 } else {
8646 first = true;
8647 }
8648 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008649 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008650 first = false;
8651 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008652 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008653 if (extras && mExtras != null) {
8654 if (!first) {
8655 b.append(' ');
8656 }
8657 first = false;
8658 b.append("(has extras)");
8659 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008660 if (mContentUserHint != UserHandle.USER_CURRENT) {
8661 if (!first) {
8662 b.append(' ');
8663 }
8664 first = false;
8665 b.append("u=").append(mContentUserHint);
8666 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008667 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008668 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008669 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008670 b.append("}");
8671 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008672 }
8673
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008674 /**
8675 * Call {@link #toUri} with 0 flags.
8676 * @deprecated Use {@link #toUri} instead.
8677 */
8678 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008679 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008680 return toUri(0);
8681 }
8682
8683 /**
8684 * Convert this Intent into a String holding a URI representation of it.
8685 * The returned URI string has been properly URI encoded, so it can be
8686 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8687 * Intent's data as the base URI, with an additional fragment describing
8688 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008689 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008690 * <p>You can convert the returned string back to an Intent with
8691 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008692 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008693 * @param flags Additional operating flags. Either 0,
8694 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008695 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008696 * @return Returns a URI encoding URI string describing the entire contents
8697 * of the Intent.
8698 */
8699 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008700 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008701 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8702 if (mPackage == null) {
8703 throw new IllegalArgumentException(
8704 "Intent must include an explicit package name to build an android-app: "
8705 + this);
8706 }
8707 uri.append("android-app://");
8708 uri.append(mPackage);
8709 String scheme = null;
8710 if (mData != null) {
8711 scheme = mData.getScheme();
8712 if (scheme != null) {
8713 uri.append('/');
8714 uri.append(scheme);
8715 String authority = mData.getEncodedAuthority();
8716 if (authority != null) {
8717 uri.append('/');
8718 uri.append(authority);
8719 String path = mData.getEncodedPath();
8720 if (path != null) {
8721 uri.append(path);
8722 }
8723 String queryParams = mData.getEncodedQuery();
8724 if (queryParams != null) {
8725 uri.append('?');
8726 uri.append(queryParams);
8727 }
8728 String fragment = mData.getEncodedFragment();
8729 if (fragment != null) {
8730 uri.append('#');
8731 uri.append(fragment);
8732 }
8733 }
8734 }
8735 }
8736 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8737 mPackage, flags);
8738 return uri.toString();
8739 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008740 String scheme = null;
8741 if (mData != null) {
8742 String data = mData.toString();
8743 if ((flags&URI_INTENT_SCHEME) != 0) {
8744 final int N = data.length();
8745 for (int i=0; i<N; i++) {
8746 char c = data.charAt(i);
8747 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8748 || c == '.' || c == '-') {
8749 continue;
8750 }
8751 if (c == ':' && i > 0) {
8752 // Valid scheme.
8753 scheme = data.substring(0, i);
8754 uri.append("intent:");
8755 data = data.substring(i+1);
8756 break;
8757 }
Tom Taylord4a47292009-12-21 13:59:18 -08008758
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008759 // No scheme.
8760 break;
8761 }
8762 }
8763 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008764
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008765 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8766 uri.append("intent:");
8767 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008768
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008769 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008770
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008771 return uri.toString();
8772 }
8773
8774 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8775 String defPackage, int flags) {
8776 StringBuilder frag = new StringBuilder(128);
8777
8778 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008779 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008780 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008781 // Note that for now we are not going to try to handle the
8782 // data part; not clear how to represent this as a URI, and
8783 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008784 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8785 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008786 }
8787
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008788 if (frag.length() > 0) {
8789 uri.append("#Intent;");
8790 uri.append(frag);
8791 uri.append("end");
8792 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008793 }
8794
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008795 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8796 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008797 if (scheme != null) {
8798 uri.append("scheme=").append(scheme).append(';');
8799 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008800 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008801 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008802 }
8803 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008804 for (int i=0; i<mCategories.size(); i++) {
8805 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008806 }
8807 }
8808 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008809 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008810 }
8811 if (mFlags != 0) {
8812 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8813 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008814 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008815 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8816 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008817 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008818 uri.append("component=").append(Uri.encode(
8819 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008820 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008821 if (mSourceBounds != null) {
8822 uri.append("sourceBounds=")
8823 .append(Uri.encode(mSourceBounds.flattenToString()))
8824 .append(';');
8825 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008826 if (mExtras != null) {
8827 for (String key : mExtras.keySet()) {
8828 final Object value = mExtras.get(key);
8829 char entryType =
8830 value instanceof String ? 'S' :
8831 value instanceof Boolean ? 'B' :
8832 value instanceof Byte ? 'b' :
8833 value instanceof Character ? 'c' :
8834 value instanceof Double ? 'd' :
8835 value instanceof Float ? 'f' :
8836 value instanceof Integer ? 'i' :
8837 value instanceof Long ? 'l' :
8838 value instanceof Short ? 's' :
8839 '\0';
8840
8841 if (entryType != '\0') {
8842 uri.append(entryType);
8843 uri.append('.');
8844 uri.append(Uri.encode(key));
8845 uri.append('=');
8846 uri.append(Uri.encode(value.toString()));
8847 uri.append(';');
8848 }
8849 }
8850 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008851 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008852
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008853 public int describeContents() {
8854 return (mExtras != null) ? mExtras.describeContents() : 0;
8855 }
8856
8857 public void writeToParcel(Parcel out, int flags) {
8858 out.writeString(mAction);
8859 Uri.writeToParcel(out, mData);
8860 out.writeString(mType);
8861 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008862 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008863 ComponentName.writeToParcel(mComponent, out);
8864
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008865 if (mSourceBounds != null) {
8866 out.writeInt(1);
8867 mSourceBounds.writeToParcel(out, flags);
8868 } else {
8869 out.writeInt(0);
8870 }
8871
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008872 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008873 final int N = mCategories.size();
8874 out.writeInt(N);
8875 for (int i=0; i<N; i++) {
8876 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008877 }
8878 } else {
8879 out.writeInt(0);
8880 }
8881
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008882 if (mSelector != null) {
8883 out.writeInt(1);
8884 mSelector.writeToParcel(out, flags);
8885 } else {
8886 out.writeInt(0);
8887 }
8888
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008889 if (mClipData != null) {
8890 out.writeInt(1);
8891 mClipData.writeToParcel(out, flags);
8892 } else {
8893 out.writeInt(0);
8894 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008895 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008896 out.writeBundle(mExtras);
8897 }
8898
8899 public static final Parcelable.Creator<Intent> CREATOR
8900 = new Parcelable.Creator<Intent>() {
8901 public Intent createFromParcel(Parcel in) {
8902 return new Intent(in);
8903 }
8904 public Intent[] newArray(int size) {
8905 return new Intent[size];
8906 }
8907 };
8908
Dianne Hackborneb034652009-09-07 00:49:58 -07008909 /** @hide */
8910 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008911 readFromParcel(in);
8912 }
8913
8914 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008915 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008916 mData = Uri.CREATOR.createFromParcel(in);
8917 mType = in.readString();
8918 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008919 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008920 mComponent = ComponentName.readFromParcel(in);
8921
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008922 if (in.readInt() != 0) {
8923 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8924 }
8925
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008926 int N = in.readInt();
8927 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008928 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008929 int i;
8930 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008931 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008932 }
8933 } else {
8934 mCategories = null;
8935 }
8936
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008937 if (in.readInt() != 0) {
8938 mSelector = new Intent(in);
8939 }
8940
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008941 if (in.readInt() != 0) {
8942 mClipData = new ClipData(in);
8943 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008944 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008945 mExtras = in.readBundle();
8946 }
8947
8948 /**
8949 * Parses the "intent" element (and its children) from XML and instantiates
8950 * an Intent object. The given XML parser should be located at the tag
8951 * where parsing should start (often named "intent"), from which the
8952 * basic action, data, type, and package and class name will be
8953 * retrieved. The function will then parse in to any child elements,
8954 * looking for <category android:name="xxx"> tags to add categories and
8955 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8956 * to the intent.
8957 *
8958 * @param resources The Resources to use when inflating resources.
8959 * @param parser The XML parser pointing at an "intent" tag.
8960 * @param attrs The AttributeSet interface for retrieving extended
8961 * attribute data at the current <var>parser</var> location.
8962 * @return An Intent object matching the XML data.
8963 * @throws XmlPullParserException If there was an XML parsing error.
8964 * @throws IOException If there was an I/O error.
8965 */
8966 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8967 throws XmlPullParserException, IOException {
8968 Intent intent = new Intent();
8969
8970 TypedArray sa = resources.obtainAttributes(attrs,
8971 com.android.internal.R.styleable.Intent);
8972
8973 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8974
8975 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8976 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8977 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8978
8979 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8980 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8981 if (packageName != null && className != null) {
8982 intent.setComponent(new ComponentName(packageName, className));
8983 }
8984
8985 sa.recycle();
8986
8987 int outerDepth = parser.getDepth();
8988 int type;
8989 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8990 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8991 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8992 continue;
8993 }
8994
8995 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008996 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008997 sa = resources.obtainAttributes(attrs,
8998 com.android.internal.R.styleable.IntentCategory);
8999 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9000 sa.recycle();
9001
9002 if (cat != null) {
9003 intent.addCategory(cat);
9004 }
9005 XmlUtils.skipCurrentTag(parser);
9006
Craig Mautner21d24a22014-04-23 11:45:37 -07009007 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009008 if (intent.mExtras == null) {
9009 intent.mExtras = new Bundle();
9010 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009011 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009012 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009013
9014 } else {
9015 XmlUtils.skipCurrentTag(parser);
9016 }
9017 }
9018
9019 return intent;
9020 }
Nick Pellyccae4122012-01-09 14:12:58 -08009021
Craig Mautner21d24a22014-04-23 11:45:37 -07009022 /** @hide */
9023 public void saveToXml(XmlSerializer out) throws IOException {
9024 if (mAction != null) {
9025 out.attribute(null, ATTR_ACTION, mAction);
9026 }
9027 if (mData != null) {
9028 out.attribute(null, ATTR_DATA, mData.toString());
9029 }
9030 if (mType != null) {
9031 out.attribute(null, ATTR_TYPE, mType);
9032 }
9033 if (mComponent != null) {
9034 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9035 }
9036 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9037
9038 if (mCategories != null) {
9039 out.startTag(null, TAG_CATEGORIES);
9040 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9041 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9042 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009043 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009044 }
9045 }
9046
9047 /** @hide */
9048 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9049 XmlPullParserException {
9050 Intent intent = new Intent();
9051 final int outerDepth = in.getDepth();
9052
9053 int attrCount = in.getAttributeCount();
9054 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9055 final String attrName = in.getAttributeName(attrNdx);
9056 final String attrValue = in.getAttributeValue(attrNdx);
9057 if (ATTR_ACTION.equals(attrName)) {
9058 intent.setAction(attrValue);
9059 } else if (ATTR_DATA.equals(attrName)) {
9060 intent.setData(Uri.parse(attrValue));
9061 } else if (ATTR_TYPE.equals(attrName)) {
9062 intent.setType(attrValue);
9063 } else if (ATTR_COMPONENT.equals(attrName)) {
9064 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9065 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009066 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009067 } else {
9068 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9069 }
9070 }
9071
9072 int event;
9073 String name;
9074 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9075 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9076 if (event == XmlPullParser.START_TAG) {
9077 name = in.getName();
9078 if (TAG_CATEGORIES.equals(name)) {
9079 attrCount = in.getAttributeCount();
9080 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9081 intent.addCategory(in.getAttributeValue(attrNdx));
9082 }
9083 } else {
9084 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9085 XmlUtils.skipCurrentTag(in);
9086 }
9087 }
9088 }
9089
9090 return intent;
9091 }
9092
Nick Pellyccae4122012-01-09 14:12:58 -08009093 /**
9094 * Normalize a MIME data type.
9095 *
9096 * <p>A normalized MIME type has white-space trimmed,
9097 * content-type parameters removed, and is lower-case.
9098 * This aligns the type with Android best practices for
9099 * intent filtering.
9100 *
9101 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9102 * "text/x-vCard" becomes "text/x-vcard".
9103 *
9104 * <p>All MIME types received from outside Android (such as user input,
9105 * or external sources like Bluetooth, NFC, or the Internet) should
9106 * be normalized before they are used to create an Intent.
9107 *
9108 * @param type MIME data type to normalize
9109 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009110 * @see #setType
9111 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009112 */
9113 public static String normalizeMimeType(String type) {
9114 if (type == null) {
9115 return null;
9116 }
9117
Elliott Hughescb64d432013-08-02 10:00:44 -07009118 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009119
9120 final int semicolonIndex = type.indexOf(';');
9121 if (semicolonIndex != -1) {
9122 type = type.substring(0, semicolonIndex);
9123 }
9124 return type;
9125 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009126
9127 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009128 * Prepare this {@link Intent} to leave an app process.
9129 *
9130 * @hide
9131 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009132 public void prepareToLeaveProcess(Context context) {
9133 final boolean leavingPackage = (mComponent == null)
9134 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9135 prepareToLeaveProcess(leavingPackage);
9136 }
9137
9138 /**
9139 * Prepare this {@link Intent} to leave an app process.
9140 *
9141 * @hide
9142 */
9143 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009144 setAllowFds(false);
9145
9146 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009147 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009148 }
9149 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009150 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009151 }
9152
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009153 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9154 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009155 switch (mAction) {
9156 case ACTION_MEDIA_REMOVED:
9157 case ACTION_MEDIA_UNMOUNTED:
9158 case ACTION_MEDIA_CHECKING:
9159 case ACTION_MEDIA_NOFS:
9160 case ACTION_MEDIA_MOUNTED:
9161 case ACTION_MEDIA_SHARED:
9162 case ACTION_MEDIA_UNSHARED:
9163 case ACTION_MEDIA_BAD_REMOVAL:
9164 case ACTION_MEDIA_UNMOUNTABLE:
9165 case ACTION_MEDIA_EJECT:
9166 case ACTION_MEDIA_SCANNER_STARTED:
9167 case ACTION_MEDIA_SCANNER_FINISHED:
9168 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009169 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9170 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009171 // Ignore legacy actions
9172 break;
9173 default:
9174 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009175 }
9176 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009177
9178 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9179 && leavingPackage) {
9180 switch (mAction) {
9181 case ACTION_PROVIDER_CHANGED:
9182 // Ignore actions that don't need to grant
9183 break;
9184 default:
9185 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9186 }
9187 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009188 }
9189
9190 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009191 * @hide
9192 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009193 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009194 // We just entered destination process, so we should be able to read all
9195 // parcelables inside.
9196 setDefusable(true);
9197
9198 if (mSelector != null) {
9199 mSelector.prepareToEnterProcess();
9200 }
9201 if (mClipData != null) {
9202 mClipData.prepareToEnterProcess();
9203 }
9204
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009205 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009206 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9207 fixUris(mContentUserHint);
9208 mContentUserHint = UserHandle.USER_CURRENT;
9209 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009210 }
9211 }
9212
9213 /**
9214 * @hide
9215 */
9216 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009217 Uri data = getData();
9218 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009219 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009220 }
9221 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009222 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009223 }
9224 String action = getAction();
9225 if (ACTION_SEND.equals(action)) {
9226 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9227 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009228 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009229 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009230 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009231 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9232 if (streams != null) {
9233 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9234 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009235 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009236 }
9237 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9238 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009239 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9240 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9241 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9242 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9243 if (output != null) {
9244 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9245 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009246 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009247 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009248
9249 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009250 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009251 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9252 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009253 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009254 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009255 * @hide
9256 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009257 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009258 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009259 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009260
9261 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009262 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009263
9264 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009265 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009266 // Inspect contained intents to see if we need to migrate extras. We
9267 // don't promote ClipData to the parent, since ChooserActivity will
9268 // already start the picked item as the caller, and we can't combine
9269 // the flags in a safe way.
9270
9271 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009272 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009273 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9274 if (intent != null) {
9275 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009276 }
9277 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009278 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009279 try {
9280 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9281 if (intents != null) {
9282 for (int i = 0; i < intents.length; i++) {
9283 final Intent intent = (Intent) intents[i];
9284 if (intent != null) {
9285 migrated |= intent.migrateExtraStreamToClipData();
9286 }
9287 }
9288 }
9289 } catch (ClassCastException e) {
9290 }
9291 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009292
9293 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009294 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009295 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9296 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9297 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9298 if (stream != null || text != null || htmlText != null) {
9299 final ClipData clipData = new ClipData(
9300 null, new String[] { getType() },
9301 new ClipData.Item(text, htmlText, null, stream));
9302 setClipData(clipData);
9303 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009304 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009305 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009306 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009307 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009308
9309 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009310 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009311 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9312 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9313 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9314 int num = -1;
9315 if (streams != null) {
9316 num = streams.size();
9317 }
9318 if (texts != null) {
9319 if (num >= 0 && num != texts.size()) {
9320 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009321 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009322 }
9323 num = texts.size();
9324 }
9325 if (htmlTexts != null) {
9326 if (num >= 0 && num != htmlTexts.size()) {
9327 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009328 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009329 }
9330 num = htmlTexts.size();
9331 }
9332 if (num > 0) {
9333 final ClipData clipData = new ClipData(
9334 null, new String[] { getType() },
9335 makeClipItem(streams, texts, htmlTexts, 0));
9336
9337 for (int i = 1; i < num; i++) {
9338 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9339 }
9340
9341 setClipData(clipData);
9342 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009343 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009344 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009345 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009346 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009347 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9348 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9349 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9350 final Uri output;
9351 try {
9352 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9353 } catch (ClassCastException e) {
9354 return false;
9355 }
9356 if (output != null) {
9357 setClipData(ClipData.newRawUri("", output));
9358 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9359 return true;
9360 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009361 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009362
9363 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009364 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009365
9366 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9367 ArrayList<String> htmlTexts, int which) {
9368 Uri uri = streams != null ? streams.get(which) : null;
9369 CharSequence text = texts != null ? texts.get(which) : null;
9370 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9371 return new ClipData.Item(text, htmlText, null, uri);
9372 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009373
9374 /** @hide */
9375 public boolean isDocument() {
9376 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9377 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009378}