blob: 8a8751e1be340dad5c32b253dda2ce528b73dc85 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
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.pm;
18
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -080019import android.annotation.SdkConstant;
20import android.annotation.SdkConstant.SdkConstantType;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080021import android.content.ComponentName;
22import android.content.Context;
23import android.content.Intent;
24import android.content.IntentFilter;
Suchi Amalapurapu1ccac752009-06-12 10:09:58 -070025import android.content.IntentSender;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080026import android.content.res.Resources;
27import android.content.res.XmlResourceParser;
28import android.graphics.drawable.Drawable;
29import android.net.Uri;
Amith Yamasani742a6712011-05-04 14:49:28 -070030import android.os.Environment;
Dianne Hackborn0c380492012-08-20 17:23:30 -070031import android.os.UserHandle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080032import android.util.AndroidException;
33import android.util.DisplayMetrics;
34
35import java.io.File;
36import java.util.List;
37
38/**
39 * Class for retrieving various kinds of information related to the application
40 * packages that are currently installed on the device.
41 *
42 * You can find this class through {@link Context#getPackageManager}.
43 */
44public abstract class PackageManager {
45
46 /**
47 * This exception is thrown when a given package, application, or component
kmccormick30498b42013-03-27 17:39:17 -070048 * name cannot be found.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080049 */
50 public static class NameNotFoundException extends AndroidException {
51 public NameNotFoundException() {
52 }
53
54 public NameNotFoundException(String name) {
55 super(name);
56 }
57 }
58
59 /**
60 * {@link PackageInfo} flag: return information about
61 * activities in the package in {@link PackageInfo#activities}.
62 */
63 public static final int GET_ACTIVITIES = 0x00000001;
64
65 /**
66 * {@link PackageInfo} flag: return information about
67 * intent receivers in the package in
68 * {@link PackageInfo#receivers}.
69 */
70 public static final int GET_RECEIVERS = 0x00000002;
71
72 /**
73 * {@link PackageInfo} flag: return information about
74 * services in the package in {@link PackageInfo#services}.
75 */
76 public static final int GET_SERVICES = 0x00000004;
77
78 /**
79 * {@link PackageInfo} flag: return information about
80 * content providers in the package in
81 * {@link PackageInfo#providers}.
82 */
83 public static final int GET_PROVIDERS = 0x00000008;
84
85 /**
86 * {@link PackageInfo} flag: return information about
87 * instrumentation in the package in
88 * {@link PackageInfo#instrumentation}.
89 */
90 public static final int GET_INSTRUMENTATION = 0x00000010;
91
92 /**
93 * {@link PackageInfo} flag: return information about the
94 * intent filters supported by the activity.
95 */
96 public static final int GET_INTENT_FILTERS = 0x00000020;
97
98 /**
99 * {@link PackageInfo} flag: return information about the
100 * signatures included in the package.
101 */
102 public static final int GET_SIGNATURES = 0x00000040;
103
104 /**
105 * {@link ResolveInfo} flag: return the IntentFilter that
106 * was matched for a particular ResolveInfo in
107 * {@link ResolveInfo#filter}.
108 */
109 public static final int GET_RESOLVED_FILTER = 0x00000040;
110
111 /**
112 * {@link ComponentInfo} flag: return the {@link ComponentInfo#metaData}
113 * data {@link android.os.Bundle}s that are associated with a component.
114 * This applies for any API returning a ComponentInfo subclass.
115 */
116 public static final int GET_META_DATA = 0x00000080;
117
118 /**
119 * {@link PackageInfo} flag: return the
120 * {@link PackageInfo#gids group ids} that are associated with an
121 * application.
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900122 * This applies for any API returning a PackageInfo class, either
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800123 * directly or nested inside of another.
124 */
125 public static final int GET_GIDS = 0x00000100;
126
127 /**
128 * {@link PackageInfo} flag: include disabled components in the returned info.
129 */
130 public static final int GET_DISABLED_COMPONENTS = 0x00000200;
131
132 /**
133 * {@link ApplicationInfo} flag: return the
134 * {@link ApplicationInfo#sharedLibraryFiles paths to the shared libraries}
135 * that are associated with an application.
136 * This applies for any API returning an ApplicationInfo class, either
137 * directly or nested inside of another.
138 */
139 public static final int GET_SHARED_LIBRARY_FILES = 0x00000400;
140
141 /**
142 * {@link ProviderInfo} flag: return the
143 * {@link ProviderInfo#uriPermissionPatterns URI permission patterns}
144 * that are associated with a content provider.
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900145 * This applies for any API returning a ProviderInfo class, either
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800146 * directly or nested inside of another.
147 */
148 public static final int GET_URI_PERMISSION_PATTERNS = 0x00000800;
149 /**
150 * {@link PackageInfo} flag: return information about
151 * permissions in the package in
152 * {@link PackageInfo#permissions}.
153 */
154 public static final int GET_PERMISSIONS = 0x00001000;
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700155
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800156 /**
Kenny Root685f4902011-11-03 10:13:29 -0700157 * Flag parameter to retrieve some information about all applications (even
158 * uninstalled ones) which have data directories. This state could have
159 * resulted if applications have been deleted with flag
160 * {@code DONT_DELETE_DATA} with a possibility of being replaced or
161 * reinstalled in future.
162 * <p>
163 * Note: this flag may cause less information about currently installed
164 * applications to be returned.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800165 */
166 public static final int GET_UNINSTALLED_PACKAGES = 0x00002000;
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700167
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800168 /**
169 * {@link PackageInfo} flag: return information about
Dianne Hackborn49237342009-08-27 20:08:01 -0700170 * hardware preferences in
171 * {@link PackageInfo#configPreferences PackageInfo.configPreferences} and
172 * requested features in {@link PackageInfo#reqFeatures
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700173 * PackageInfo.reqFeatures}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800174 */
175 public static final int GET_CONFIGURATIONS = 0x00004000;
176
177 /**
Dianne Hackbornfd7aded2013-01-22 17:10:23 -0800178 * {@link PackageInfo} flag: include disabled components which are in
179 * that state only because of {@link #COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED}
180 * in the returned info. Note that if you set this flag, applications
181 * that are in this disabled state will be reported as enabled.
182 */
183 public static final int GET_DISABLED_UNTIL_USED_COMPONENTS = 0x00008000;
184
185 /**
Dianne Hackborn1655be42009-05-08 14:29:01 -0700186 * Resolution and querying flag: if set, only filters that support the
187 * {@link android.content.Intent#CATEGORY_DEFAULT} will be considered for
188 * matching. This is a synonym for including the CATEGORY_DEFAULT in your
189 * supplied Intent.
190 */
191 public static final int MATCH_DEFAULT_ONLY = 0x00010000;
192
193 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800194 * Permission check result: this is returned by {@link #checkPermission}
195 * if the permission has been granted to the given package.
196 */
197 public static final int PERMISSION_GRANTED = 0;
198
199 /**
200 * Permission check result: this is returned by {@link #checkPermission}
201 * if the permission has not been granted to the given package.
202 */
203 public static final int PERMISSION_DENIED = -1;
204
205 /**
206 * Signature check result: this is returned by {@link #checkSignatures}
Chris Palmer09f33602010-09-13 14:27:18 -0700207 * if all signatures on the two packages match.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800208 */
209 public static final int SIGNATURE_MATCH = 0;
210
211 /**
212 * Signature check result: this is returned by {@link #checkSignatures}
213 * if neither of the two packages is signed.
214 */
215 public static final int SIGNATURE_NEITHER_SIGNED = 1;
216
217 /**
218 * Signature check result: this is returned by {@link #checkSignatures}
Chris Palmer09f33602010-09-13 14:27:18 -0700219 * if the first package is not signed but the second is.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800220 */
221 public static final int SIGNATURE_FIRST_NOT_SIGNED = -1;
222
223 /**
224 * Signature check result: this is returned by {@link #checkSignatures}
Chris Palmer09f33602010-09-13 14:27:18 -0700225 * if the second package is not signed but the first is.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800226 */
227 public static final int SIGNATURE_SECOND_NOT_SIGNED = -2;
228
229 /**
230 * Signature check result: this is returned by {@link #checkSignatures}
Chris Palmer09f33602010-09-13 14:27:18 -0700231 * if not all signatures on both packages match.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800232 */
233 public static final int SIGNATURE_NO_MATCH = -3;
234
235 /**
236 * Signature check result: this is returned by {@link #checkSignatures}
Chris Palmer09f33602010-09-13 14:27:18 -0700237 * if either of the packages are not valid.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800238 */
239 public static final int SIGNATURE_UNKNOWN_PACKAGE = -4;
240
Dianne Hackborn0ac30312011-06-17 14:49:23 -0700241 /**
242 * Flag for {@link #setApplicationEnabledSetting(String, int, int)}
243 * and {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
244 * component or application is in its default enabled state (as specified
245 * in its manifest).
246 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800247 public static final int COMPONENT_ENABLED_STATE_DEFAULT = 0;
Dianne Hackborn0ac30312011-06-17 14:49:23 -0700248
249 /**
250 * Flag for {@link #setApplicationEnabledSetting(String, int, int)}
251 * and {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
252 * component or application has been explictily enabled, regardless of
253 * what it has specified in its manifest.
254 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800255 public static final int COMPONENT_ENABLED_STATE_ENABLED = 1;
Dianne Hackborn0ac30312011-06-17 14:49:23 -0700256
257 /**
258 * Flag for {@link #setApplicationEnabledSetting(String, int, int)}
259 * and {@link #setComponentEnabledSetting(ComponentName, int, int)}: This
260 * component or application has been explicitly disabled, regardless of
261 * what it has specified in its manifest.
262 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800263 public static final int COMPONENT_ENABLED_STATE_DISABLED = 2;
264
265 /**
Dianne Hackborn0ac30312011-06-17 14:49:23 -0700266 * Flag for {@link #setApplicationEnabledSetting(String, int, int)} only: The
267 * user has explicitly disabled the application, regardless of what it has
268 * specified in its manifest. Because this is due to the user's request,
269 * they may re-enable it if desired through the appropriate system UI. This
kmccormick30498b42013-03-27 17:39:17 -0700270 * option currently <strong>cannot</strong> be used with
Dianne Hackborn0ac30312011-06-17 14:49:23 -0700271 * {@link #setComponentEnabledSetting(ComponentName, int, int)}.
272 */
273 public static final int COMPONENT_ENABLED_STATE_DISABLED_USER = 3;
274
275 /**
Dianne Hackbornfd7aded2013-01-22 17:10:23 -0800276 * Flag for {@link #setApplicationEnabledSetting(String, int, int)} only: This
277 * application should be considered, until the point where the user actually
278 * wants to use it. This means that it will not normally show up to the user
279 * (such as in the launcher), but various parts of the user interface can
280 * use {@link #GET_DISABLED_UNTIL_USED_COMPONENTS} to still see it and allow
281 * the user to select it (as for example an IME, device admin, etc). Such code,
282 * once the user has selected the app, should at that point also make it enabled.
283 * This option currently <strong>can not</strong> be used with
284 * {@link #setComponentEnabledSetting(ComponentName, int, int)}.
285 */
286 public static final int COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED = 4;
287
288 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800289 * Flag parameter for {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} to
290 * indicate that this package should be installed as forward locked, i.e. only the app itself
Brad Fitzpatrick2e805b12010-03-22 10:10:51 -0700291 * should have access to its code and non-resource assets.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700292 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800293 */
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700294 public static final int INSTALL_FORWARD_LOCK = 0x00000001;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800295
296 /**
297 * Flag parameter for {@link #installPackage} to indicate that you want to replace an already
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700298 * installed package, if one exists.
299 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800300 */
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700301 public static final int INSTALL_REPLACE_EXISTING = 0x00000002;
302
303 /**
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700304 * Flag parameter for {@link #installPackage} to indicate that you want to
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700305 * allow test packages (those that have set android:testOnly in their
306 * manifest) to be installed.
307 * @hide
308 */
309 public static final int INSTALL_ALLOW_TEST = 0x00000004;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800310
311 /**
Suchi Amalapurapuaf8e9f42010-01-12 10:17:28 -0800312 * Flag parameter for {@link #installPackage} to indicate that this
313 * package has to be installed on the sdcard.
314 * @hide
315 */
Suchi Amalapurapu5b993ce2010-02-12 09:43:29 -0800316 public static final int INSTALL_EXTERNAL = 0x00000008;
Oscar Montemayor539d3c42010-01-29 15:27:00 -0800317
318 /**
Kenny Root5ab21572011-07-27 11:11:19 -0700319 * Flag parameter for {@link #installPackage} to indicate that this package
320 * has to be installed on the sdcard.
321 * @hide
322 */
323 public static final int INSTALL_INTERNAL = 0x00000010;
324
325 /**
326 * Flag parameter for {@link #installPackage} to indicate that this install
327 * was initiated via ADB.
328 *
329 * @hide
330 */
331 public static final int INSTALL_FROM_ADB = 0x00000020;
Suchi Amalapurapu14b6abd2010-03-17 08:37:04 -0700332
333 /**
Dianne Hackborn7767eac2012-08-23 18:25:40 -0700334 * Flag parameter for {@link #installPackage} to indicate that this install
335 * should immediately be visible to all users.
336 *
337 * @hide
338 */
339 public static final int INSTALL_ALL_USERS = 0x00000040;
340
341 /**
342 * Flag parameter for {@link #installPackage} to indicate that it is okay
343 * to install an update to an app where the newly installed app has a lower
344 * version code than the currently installed app.
345 *
346 * @hide
347 */
348 public static final int INSTALL_ALLOW_DOWNGRADE = 0x00000080;
349
350 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800351 * Flag parameter for
352 * {@link #setComponentEnabledSetting(android.content.ComponentName, int, int)} to indicate
353 * that you don't want to kill the app containing the component. Be careful when you set this
354 * since changing component states can make the containing application's behavior unpredictable.
355 */
356 public static final int DONT_KILL_APP = 0x00000001;
357
358 /**
359 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
360 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} on success.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700361 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800362 */
363 public static final int INSTALL_SUCCEEDED = 1;
364
365 /**
366 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
367 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if the package is
368 * already installed.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700369 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800370 */
371 public static final int INSTALL_FAILED_ALREADY_EXISTS = -1;
372
373 /**
374 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
375 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if the package archive
376 * file is invalid.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700377 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800378 */
379 public static final int INSTALL_FAILED_INVALID_APK = -2;
380
381 /**
382 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
383 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if the URI passed in
384 * is invalid.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700385 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800386 */
387 public static final int INSTALL_FAILED_INVALID_URI = -3;
388
389 /**
390 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
391 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if the package manager
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700392 * service found that the device didn't have enough storage space to install the app.
393 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800394 */
395 public static final int INSTALL_FAILED_INSUFFICIENT_STORAGE = -4;
396
397 /**
398 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
399 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if a
400 * package is already installed with the same name.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700401 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800402 */
403 public static final int INSTALL_FAILED_DUPLICATE_PACKAGE = -5;
404
405 /**
406 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
407 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
408 * the requested shared user does not exist.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700409 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800410 */
411 public static final int INSTALL_FAILED_NO_SHARED_USER = -6;
412
413 /**
414 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
415 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
416 * a previously installed package of the same name has a different signature
417 * than the new package (and the old package's data was not removed).
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700418 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800419 */
420 public static final int INSTALL_FAILED_UPDATE_INCOMPATIBLE = -7;
421
422 /**
423 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
424 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
425 * the new package is requested a shared user which is already installed on the
426 * device and does not have matching signature.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700427 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800428 */
429 public static final int INSTALL_FAILED_SHARED_USER_INCOMPATIBLE = -8;
430
431 /**
432 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
433 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
434 * the new package uses a shared library that is not available.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700435 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800436 */
437 public static final int INSTALL_FAILED_MISSING_SHARED_LIBRARY = -9;
438
439 /**
440 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
441 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
442 * the new package uses a shared library that is not available.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700443 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800444 */
445 public static final int INSTALL_FAILED_REPLACE_COULDNT_DELETE = -10;
446
447 /**
448 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
449 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
450 * the new package failed while optimizing and validating its dex files,
451 * either because there was not enough storage or the validation failed.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700452 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800453 */
454 public static final int INSTALL_FAILED_DEXOPT = -11;
455
456 /**
457 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
458 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
459 * the new package failed because the current SDK version is older than
460 * that required by the package.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700461 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800462 */
463 public static final int INSTALL_FAILED_OLDER_SDK = -12;
464
465 /**
The Android Open Source Project10592532009-03-18 17:39:46 -0700466 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
467 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
468 * the new package failed because it contains a content provider with the
469 * same authority as a provider already installed in the system.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700470 * @hide
The Android Open Source Project10592532009-03-18 17:39:46 -0700471 */
472 public static final int INSTALL_FAILED_CONFLICTING_PROVIDER = -13;
473
474 /**
Dianne Hackborn851a5412009-05-08 12:06:44 -0700475 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
476 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
477 * the new package failed because the current SDK version is newer than
478 * that required by the package.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700479 * @hide
Dianne Hackborn851a5412009-05-08 12:06:44 -0700480 */
481 public static final int INSTALL_FAILED_NEWER_SDK = -14;
482
483 /**
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700484 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
485 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
486 * the new package failed because it has specified that it is a test-only
487 * package and the caller has not supplied the {@link #INSTALL_ALLOW_TEST}
488 * flag.
489 * @hide
490 */
491 public static final int INSTALL_FAILED_TEST_ONLY = -15;
492
493 /**
Dianne Hackbornb1811182009-05-21 15:45:42 -0700494 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
495 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
496 * the package being installed contains native code, but none that is
497 * compatible with the the device's CPU_ABI.
498 * @hide
499 */
500 public static final int INSTALL_FAILED_CPU_ABI_INCOMPATIBLE = -16;
501
502 /**
Dianne Hackborn49237342009-08-27 20:08:01 -0700503 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
504 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
505 * the new package uses a feature that is not available.
506 * @hide
507 */
508 public static final int INSTALL_FAILED_MISSING_FEATURE = -17;
509
Suchi Amalapurapuaf8e9f42010-01-12 10:17:28 -0800510 // ------ Errors related to sdcard
511 /**
512 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
513 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
514 * a secure container mount point couldn't be accessed on external media.
515 * @hide
516 */
517 public static final int INSTALL_FAILED_CONTAINER_ERROR = -18;
518
Dianne Hackborn49237342009-08-27 20:08:01 -0700519 /**
Suchi Amalapurapub56ae202010-02-04 22:51:07 -0800520 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
521 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
522 * the new package couldn't be installed in the specified install
523 * location.
524 * @hide
525 */
526 public static final int INSTALL_FAILED_INVALID_INSTALL_LOCATION = -19;
527
528 /**
Suchi Amalapurapu8a9ab242010-03-11 16:49:16 -0800529 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
530 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
531 * the new package couldn't be installed in the specified install
532 * location because the media is not available.
533 * @hide
534 */
535 public static final int INSTALL_FAILED_MEDIA_UNAVAILABLE = -20;
536
537 /**
Kenny Root5ab21572011-07-27 11:11:19 -0700538 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
539 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
540 * the new package couldn't be installed because the verification timed out.
541 * @hide
542 */
543 public static final int INSTALL_FAILED_VERIFICATION_TIMEOUT = -21;
544
545 /**
546 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
547 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
548 * the new package couldn't be installed because the verification did not succeed.
549 * @hide
550 */
551 public static final int INSTALL_FAILED_VERIFICATION_FAILURE = -22;
552
553 /**
554 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
555 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
556 * the package changed from what the calling program expected.
557 * @hide
558 */
559 public static final int INSTALL_FAILED_PACKAGE_CHANGED = -23;
560
561 /**
Dianne Hackbornd0c5f512012-06-07 16:53:59 -0700562 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
563 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
564 * the new package is assigned a different UID than it previously held.
565 * @hide
566 */
567 public static final int INSTALL_FAILED_UID_CHANGED = -24;
568
569 /**
Dianne Hackborn7767eac2012-08-23 18:25:40 -0700570 * Installation return code: this is passed to the {@link IPackageInstallObserver} by
571 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)} if
572 * the new package has an older version code than the currently installed package.
573 * @hide
574 */
575 public static final int INSTALL_FAILED_VERSION_DOWNGRADE = -25;
576
577 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800578 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
579 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
580 * if the parser was given a path that is not a file, or does not end with the expected
581 * '.apk' extension.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700582 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800583 */
584 public static final int INSTALL_PARSE_FAILED_NOT_APK = -100;
585
586 /**
587 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
588 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
589 * if the parser was unable to retrieve the AndroidManifest.xml file.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700590 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800591 */
592 public static final int INSTALL_PARSE_FAILED_BAD_MANIFEST = -101;
593
594 /**
595 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
596 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
597 * if the parser encountered an unexpected exception.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700598 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800599 */
600 public static final int INSTALL_PARSE_FAILED_UNEXPECTED_EXCEPTION = -102;
601
602 /**
603 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
604 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
605 * if the parser did not find any certificates in the .apk.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700606 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800607 */
608 public static final int INSTALL_PARSE_FAILED_NO_CERTIFICATES = -103;
609
610 /**
611 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
612 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
613 * if the parser found inconsistent certificates on the files in the .apk.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700614 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800615 */
616 public static final int INSTALL_PARSE_FAILED_INCONSISTENT_CERTIFICATES = -104;
617
618 /**
619 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
620 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
621 * if the parser encountered a CertificateEncodingException in one of the
622 * files in the .apk.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700623 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800624 */
625 public static final int INSTALL_PARSE_FAILED_CERTIFICATE_ENCODING = -105;
626
627 /**
628 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
629 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
630 * if the parser encountered a bad or missing package name in the manifest.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700631 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800632 */
633 public static final int INSTALL_PARSE_FAILED_BAD_PACKAGE_NAME = -106;
634
635 /**
636 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
637 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
638 * if the parser encountered a bad shared user id name in the manifest.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700639 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800640 */
641 public static final int INSTALL_PARSE_FAILED_BAD_SHARED_USER_ID = -107;
642
643 /**
644 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
645 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
646 * if the parser encountered some structural problem in the manifest.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700647 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800648 */
649 public static final int INSTALL_PARSE_FAILED_MANIFEST_MALFORMED = -108;
650
651 /**
652 * Installation parse return code: this is passed to the {@link IPackageInstallObserver} by
653 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
654 * if the parser did not find any actionable tags (instrumentation or application)
655 * in the manifest.
Dianne Hackbornade3eca2009-05-11 18:54:45 -0700656 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800657 */
658 public static final int INSTALL_PARSE_FAILED_MANIFEST_EMPTY = -109;
659
660 /**
Suchi Amalapurapu5b993ce2010-02-12 09:43:29 -0800661 * Installation failed return code: this is passed to the {@link IPackageInstallObserver} by
662 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
663 * if the system failed to install the package because of system issues.
664 * @hide
665 */
666 public static final int INSTALL_FAILED_INTERNAL_ERROR = -110;
667
668 /**
Amith Yamasanie4cf7342012-12-17 11:12:09 -0800669 * Installation failed return code: this is passed to the {@link IPackageInstallObserver} by
670 * {@link #installPackage(android.net.Uri, IPackageInstallObserver, int)}
671 * if the system failed to install the package because the user is restricted from installing
672 * apps.
673 * @hide
674 */
675 public static final int INSTALL_FAILED_USER_RESTRICTED = -111;
676
677 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800678 * Flag parameter for {@link #deletePackage} to indicate that you don't want to delete the
679 * package's data directory.
680 *
681 * @hide
682 */
Dianne Hackborn7767eac2012-08-23 18:25:40 -0700683 public static final int DELETE_KEEP_DATA = 0x00000001;
684
685 /**
686 * Flag parameter for {@link #deletePackage} to indicate that you want the
687 * package deleted for all users.
688 *
689 * @hide
690 */
691 public static final int DELETE_ALL_USERS = 0x00000002;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800692
693 /**
Dianne Hackbornc895be72013-03-11 17:48:43 -0700694 * Flag parameter for {@link #deletePackage} to indicate that, if you are calling
695 * uninstall on a system that has been updated, then don't do the normal process
696 * of uninstalling the update and rolling back to the older system version (which
697 * needs to happen for all users); instead, just mark the app as uninstalled for
698 * the current user.
699 *
700 * @hide
701 */
702 public static final int DELETE_SYSTEM_APP = 0x00000004;
703
704 /**
Kenny Rootc39bb4a2011-02-28 13:27:19 -0800705 * Return code for when package deletion succeeds. This is passed to the
706 * {@link IPackageDeleteObserver} by {@link #deletePackage()} if the system
707 * succeeded in deleting the package.
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700708 *
Kenny Rootc39bb4a2011-02-28 13:27:19 -0800709 * @hide
710 */
711 public static final int DELETE_SUCCEEDED = 1;
712
713 /**
714 * Deletion failed return code: this is passed to the
715 * {@link IPackageDeleteObserver} by {@link #deletePackage()} if the system
716 * failed to delete the package for an unspecified reason.
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700717 *
Kenny Rootc39bb4a2011-02-28 13:27:19 -0800718 * @hide
719 */
720 public static final int DELETE_FAILED_INTERNAL_ERROR = -1;
721
722 /**
723 * Deletion failed return code: this is passed to the
724 * {@link IPackageDeleteObserver} by {@link #deletePackage()} if the system
725 * failed to delete the package because it is the active DevicePolicy
726 * manager.
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700727 *
Kenny Rootc39bb4a2011-02-28 13:27:19 -0800728 * @hide
729 */
730 public static final int DELETE_FAILED_DEVICE_POLICY_MANAGER = -2;
731
732 /**
Amith Yamasanie4cf7342012-12-17 11:12:09 -0800733 * Deletion failed return code: this is passed to the
734 * {@link IPackageDeleteObserver} by {@link #deletePackage()} if the system
735 * failed to delete the package since the user is restricted.
736 *
737 * @hide
738 */
739 public static final int DELETE_FAILED_USER_RESTRICTED = -3;
740
741 /**
Suchi Amalapurapu8946dd32010-02-19 09:19:34 -0800742 * Return code that is passed to the {@link IPackageMoveObserver} by
Kenny Rootc39bb4a2011-02-28 13:27:19 -0800743 * {@link #movePackage(android.net.Uri, IPackageMoveObserver)} when the
744 * package has been successfully moved by the system.
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700745 *
Suchi Amalapurapu8946dd32010-02-19 09:19:34 -0800746 * @hide
747 */
748 public static final int MOVE_SUCCEEDED = 1;
749 /**
750 * Error code that is passed to the {@link IPackageMoveObserver} by
751 * {@link #movePackage(android.net.Uri, IPackageMoveObserver)}
752 * when the package hasn't been successfully moved by the system
753 * because of insufficient memory on specified media.
754 * @hide
755 */
756 public static final int MOVE_FAILED_INSUFFICIENT_STORAGE = -1;
757
758 /**
759 * Error code that is passed to the {@link IPackageMoveObserver} by
760 * {@link #movePackage(android.net.Uri, IPackageMoveObserver)}
761 * if the specified package doesn't exist.
762 * @hide
763 */
764 public static final int MOVE_FAILED_DOESNT_EXIST = -2;
765
766 /**
767 * Error code that is passed to the {@link IPackageMoveObserver} by
768 * {@link #movePackage(android.net.Uri, IPackageMoveObserver)}
769 * if the specified package cannot be moved since its a system package.
770 * @hide
771 */
772 public static final int MOVE_FAILED_SYSTEM_PACKAGE = -3;
773
774 /**
775 * Error code that is passed to the {@link IPackageMoveObserver} by
776 * {@link #movePackage(android.net.Uri, IPackageMoveObserver)}
777 * if the specified package cannot be moved since its forward locked.
778 * @hide
779 */
780 public static final int MOVE_FAILED_FORWARD_LOCKED = -4;
781
782 /**
783 * Error code that is passed to the {@link IPackageMoveObserver} by
784 * {@link #movePackage(android.net.Uri, IPackageMoveObserver)}
785 * if the specified package cannot be moved to the specified location.
786 * @hide
787 */
788 public static final int MOVE_FAILED_INVALID_LOCATION = -5;
789
790 /**
Suchi Amalapurapu8a9ab242010-03-11 16:49:16 -0800791 * Error code that is passed to the {@link IPackageMoveObserver} by
792 * {@link #movePackage(android.net.Uri, IPackageMoveObserver)}
793 * if the specified package cannot be moved to the specified location.
794 * @hide
795 */
796 public static final int MOVE_FAILED_INTERNAL_ERROR = -6;
797
798 /**
Kenny Rootdeb11262010-08-02 11:36:21 -0700799 * Error code that is passed to the {@link IPackageMoveObserver} by
800 * {@link #movePackage(android.net.Uri, IPackageMoveObserver)} if the
801 * specified package already has an operation pending in the
802 * {@link PackageHandler} queue.
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700803 *
Kenny Rootdeb11262010-08-02 11:36:21 -0700804 * @hide
805 */
806 public static final int MOVE_FAILED_OPERATION_PENDING = -7;
807
808 /**
Suchi Amalapurapu8946dd32010-02-19 09:19:34 -0800809 * Flag parameter for {@link #movePackage} to indicate that
810 * the package should be moved to internal storage if its
811 * been installed on external media.
812 * @hide
813 */
814 public static final int MOVE_INTERNAL = 0x00000001;
815
816 /**
817 * Flag parameter for {@link #movePackage} to indicate that
818 * the package should be moved to external media.
819 * @hide
820 */
821 public static final int MOVE_EXTERNAL_MEDIA = 0x00000002;
822
823 /**
Kenny Root05ca4c92011-09-15 10:36:25 -0700824 * Usable by the required verifier as the {@code verificationCode} argument
825 * for {@link PackageManager#verifyPendingInstall} to indicate that it will
826 * allow the installation to proceed without any of the optional verifiers
827 * needing to vote.
828 *
829 * @hide
830 */
831 public static final int VERIFICATION_ALLOW_WITHOUT_SUFFICIENT = 2;
832
833 /**
Kenny Root3a9b5fb2011-09-20 14:15:38 -0700834 * Used as the {@code verificationCode} argument for
835 * {@link PackageManager#verifyPendingInstall} to indicate that the calling
836 * package verifier allows the installation to proceed.
837 */
838 public static final int VERIFICATION_ALLOW = 1;
839
840 /**
841 * Used as the {@code verificationCode} argument for
842 * {@link PackageManager#verifyPendingInstall} to indicate the calling
843 * package verifier does not vote to allow the installation to proceed.
844 */
845 public static final int VERIFICATION_REJECT = -1;
846
847 /**
rich canningsd9ef3e52012-08-22 14:28:05 -0700848 * Can be used as the {@code millisecondsToDelay} argument for
849 * {@link PackageManager#extendVerificationTimeout}. This is the
850 * maximum time {@code PackageManager} waits for the verification
851 * agent to return (in milliseconds).
852 */
853 public static final long MAXIMUM_VERIFICATION_TIMEOUT = 60*60*1000;
854
855 /**
Amith Yamasani0b285492011-04-14 17:35:23 -0700856 * Feature for {@link #getSystemAvailableFeatures} and {@link #hasSystemFeature}: The device's
857 * audio pipeline is low-latency, more suitable for audio applications sensitive to delays or
858 * lag in sound input or output.
Dan Morrill898e1e82010-09-26 17:28:30 -0700859 */
860 @SdkConstant(SdkConstantType.FEATURE)
861 public static final String FEATURE_AUDIO_LOW_LATENCY = "android.hardware.audio.low_latency";
862
863 /**
864 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill50ab63f2010-03-05 16:16:19 -0800865 * {@link #hasSystemFeature}: The device is capable of communicating with
866 * other devices via Bluetooth.
867 */
868 @SdkConstant(SdkConstantType.FEATURE)
869 public static final String FEATURE_BLUETOOTH = "android.hardware.bluetooth";
870
871 /**
872 * Feature for {@link #getSystemAvailableFeatures} and
Matthew Xiea7227722013-04-18 15:25:59 -0700873 * {@link #hasSystemFeature}: The device is capable of communicating with
874 * other devices via Bluetooth Low Energy radio.
875 */
876 @SdkConstant(SdkConstantType.FEATURE)
877 public static final String FEATURE_BLUETOOTH_LE = "android.hardware.bluetooth_le";
878
879 /**
880 * Feature for {@link #getSystemAvailableFeatures} and
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800881 * {@link #hasSystemFeature}: The device has a camera facing away
882 * from the screen.
883 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -0800884 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800885 public static final String FEATURE_CAMERA = "android.hardware.camera";
Dan Morrill50ab63f2010-03-05 16:16:19 -0800886
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800887 /**
888 * Feature for {@link #getSystemAvailableFeatures} and
889 * {@link #hasSystemFeature}: The device's camera supports auto-focus.
890 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -0800891 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800892 public static final String FEATURE_CAMERA_AUTOFOCUS = "android.hardware.camera.autofocus";
Dan Morrill50ab63f2010-03-05 16:16:19 -0800893
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800894 /**
895 * Feature for {@link #getSystemAvailableFeatures} and
Eino-Ville Talvala752af832012-09-18 14:45:37 -0700896 * {@link #hasSystemFeature}: The device has at least one camera pointing in
897 * some direction.
Eino-Ville Talvala752af832012-09-18 14:45:37 -0700898 */
899 @SdkConstant(SdkConstantType.FEATURE)
900 public static final String FEATURE_CAMERA_ANY = "android.hardware.camera.any";
901
902 /**
903 * Feature for {@link #getSystemAvailableFeatures} and
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800904 * {@link #hasSystemFeature}: The device's camera supports flash.
905 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -0800906 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800907 public static final String FEATURE_CAMERA_FLASH = "android.hardware.camera.flash";
Dan Morrill50ab63f2010-03-05 16:16:19 -0800908
909 /**
910 * Feature for {@link #getSystemAvailableFeatures} and
Chih-Chung Changde1057c2010-06-14 19:15:00 +0800911 * {@link #hasSystemFeature}: The device has a front facing camera.
912 */
913 @SdkConstant(SdkConstantType.FEATURE)
914 public static final String FEATURE_CAMERA_FRONT = "android.hardware.camera.front";
915
916 /**
917 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill50ab63f2010-03-05 16:16:19 -0800918 * {@link #hasSystemFeature}: The device supports one or more methods of
919 * reporting current location.
920 */
921 @SdkConstant(SdkConstantType.FEATURE)
922 public static final String FEATURE_LOCATION = "android.hardware.location";
923
924 /**
925 * Feature for {@link #getSystemAvailableFeatures} and
926 * {@link #hasSystemFeature}: The device has a Global Positioning System
927 * receiver and can report precise location.
928 */
929 @SdkConstant(SdkConstantType.FEATURE)
930 public static final String FEATURE_LOCATION_GPS = "android.hardware.location.gps";
931
932 /**
933 * Feature for {@link #getSystemAvailableFeatures} and
934 * {@link #hasSystemFeature}: The device can report location with coarse
935 * accuracy using a network-based geolocation system.
936 */
937 @SdkConstant(SdkConstantType.FEATURE)
938 public static final String FEATURE_LOCATION_NETWORK = "android.hardware.location.network";
939
940 /**
941 * Feature for {@link #getSystemAvailableFeatures} and
942 * {@link #hasSystemFeature}: The device can record audio via a
943 * microphone.
944 */
945 @SdkConstant(SdkConstantType.FEATURE)
946 public static final String FEATURE_MICROPHONE = "android.hardware.microphone";
947
948 /**
949 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill76437d32010-09-01 11:17:20 -0700950 * {@link #hasSystemFeature}: The device can communicate using Near-Field
951 * Communications (NFC).
952 */
953 @SdkConstant(SdkConstantType.FEATURE)
954 public static final String FEATURE_NFC = "android.hardware.nfc";
955
956 /**
957 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill5744bb42010-09-01 19:18:57 -0700958 * {@link #hasSystemFeature}: The device includes an accelerometer.
959 */
960 @SdkConstant(SdkConstantType.FEATURE)
961 public static final String FEATURE_SENSOR_ACCELEROMETER = "android.hardware.sensor.accelerometer";
962
963 /**
964 * Feature for {@link #getSystemAvailableFeatures} and
965 * {@link #hasSystemFeature}: The device includes a barometer (air
966 * pressure sensor.)
967 */
968 @SdkConstant(SdkConstantType.FEATURE)
969 public static final String FEATURE_SENSOR_BAROMETER = "android.hardware.sensor.barometer";
970
971 /**
972 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill50ab63f2010-03-05 16:16:19 -0800973 * {@link #hasSystemFeature}: The device includes a magnetometer (compass).
974 */
975 @SdkConstant(SdkConstantType.FEATURE)
976 public static final String FEATURE_SENSOR_COMPASS = "android.hardware.sensor.compass";
977
978 /**
979 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill5744bb42010-09-01 19:18:57 -0700980 * {@link #hasSystemFeature}: The device includes a gyroscope.
Dan Morrill50ab63f2010-03-05 16:16:19 -0800981 */
982 @SdkConstant(SdkConstantType.FEATURE)
Dan Morrill5744bb42010-09-01 19:18:57 -0700983 public static final String FEATURE_SENSOR_GYROSCOPE = "android.hardware.sensor.gyroscope";
Dan Morrill50ab63f2010-03-05 16:16:19 -0800984
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800985 /**
986 * Feature for {@link #getSystemAvailableFeatures} and
987 * {@link #hasSystemFeature}: The device includes a light sensor.
988 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -0800989 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800990 public static final String FEATURE_SENSOR_LIGHT = "android.hardware.sensor.light";
Dan Morrill50ab63f2010-03-05 16:16:19 -0800991
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800992 /**
993 * Feature for {@link #getSystemAvailableFeatures} and
994 * {@link #hasSystemFeature}: The device includes a proximity sensor.
995 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -0800996 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800997 public static final String FEATURE_SENSOR_PROXIMITY = "android.hardware.sensor.proximity";
Amith Yamasani4b2e9342011-03-31 12:38:53 -0700998
Dianne Hackborn08ee42c2009-11-19 17:08:01 -0800999 /**
1000 * Feature for {@link #getSystemAvailableFeatures} and
1001 * {@link #hasSystemFeature}: The device has a telephony radio with data
1002 * communication support.
1003 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -08001004 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001005 public static final String FEATURE_TELEPHONY = "android.hardware.telephony";
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001006
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001007 /**
1008 * Feature for {@link #getSystemAvailableFeatures} and
1009 * {@link #hasSystemFeature}: The device has a CDMA telephony stack.
1010 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -08001011 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001012 public static final String FEATURE_TELEPHONY_CDMA = "android.hardware.telephony.cdma";
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001013
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001014 /**
1015 * Feature for {@link #getSystemAvailableFeatures} and
1016 * {@link #hasSystemFeature}: The device has a GSM telephony stack.
1017 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -08001018 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001019 public static final String FEATURE_TELEPHONY_GSM = "android.hardware.telephony.gsm";
Hung-ying Tyan3424c022010-08-27 18:08:19 +08001020
1021 /**
1022 * Feature for {@link #getSystemAvailableFeatures} and
Mike Lockwoodf4ca2472011-02-27 11:23:25 -08001023 * {@link #hasSystemFeature}: The device supports connecting to USB devices
1024 * as the USB host.
1025 */
1026 @SdkConstant(SdkConstantType.FEATURE)
1027 public static final String FEATURE_USB_HOST = "android.hardware.usb.host";
1028
1029 /**
1030 * Feature for {@link #getSystemAvailableFeatures} and
1031 * {@link #hasSystemFeature}: The device supports connecting to USB accessories.
1032 */
1033 @SdkConstant(SdkConstantType.FEATURE)
1034 public static final String FEATURE_USB_ACCESSORY = "android.hardware.usb.accessory";
1035
1036 /**
1037 * Feature for {@link #getSystemAvailableFeatures} and
Hung-ying Tyan3424c022010-08-27 18:08:19 +08001038 * {@link #hasSystemFeature}: The SIP API is enabled on the device.
1039 */
1040 @SdkConstant(SdkConstantType.FEATURE)
1041 public static final String FEATURE_SIP = "android.software.sip";
1042
1043 /**
1044 * Feature for {@link #getSystemAvailableFeatures} and
1045 * {@link #hasSystemFeature}: The device supports SIP-based VOIP.
1046 */
1047 @SdkConstant(SdkConstantType.FEATURE)
1048 public static final String FEATURE_SIP_VOIP = "android.software.sip.voip";
1049
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001050 /**
1051 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrillb0fe0332010-04-05 14:43:58 -07001052 * {@link #hasSystemFeature}: The device's display has a touch screen.
1053 */
1054 @SdkConstant(SdkConstantType.FEATURE)
1055 public static final String FEATURE_TOUCHSCREEN = "android.hardware.touchscreen";
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001056
1057
Dan Morrillb0fe0332010-04-05 14:43:58 -07001058 /**
1059 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill50ab63f2010-03-05 16:16:19 -08001060 * {@link #hasSystemFeature}: The device's touch screen supports
1061 * multitouch sufficient for basic two-finger gesture detection.
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001062 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -08001063 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001064 public static final String FEATURE_TOUCHSCREEN_MULTITOUCH = "android.hardware.touchscreen.multitouch";
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001065
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001066 /**
1067 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill50ab63f2010-03-05 16:16:19 -08001068 * {@link #hasSystemFeature}: The device's touch screen is capable of
1069 * tracking two or more fingers fully independently.
1070 */
1071 @SdkConstant(SdkConstantType.FEATURE)
1072 public static final String FEATURE_TOUCHSCREEN_MULTITOUCH_DISTINCT = "android.hardware.touchscreen.multitouch.distinct";
1073
1074 /**
1075 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill6993d3d2010-09-03 14:30:14 -07001076 * {@link #hasSystemFeature}: The device's touch screen is capable of
1077 * tracking a full hand of fingers fully independently -- that is, 5 or
1078 * more simultaneous independent pointers.
1079 */
1080 @SdkConstant(SdkConstantType.FEATURE)
1081 public static final String FEATURE_TOUCHSCREEN_MULTITOUCH_JAZZHAND = "android.hardware.touchscreen.multitouch.jazzhand";
1082
1083 /**
1084 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrilla5376872011-01-23 13:15:53 -08001085 * {@link #hasSystemFeature}: The device does not have a touch screen, but
1086 * does support touch emulation for basic events. For instance, the
1087 * device might use a mouse or remote control to drive a cursor, and
1088 * emulate basic touch pointer events like down, up, drag, etc. All
1089 * devices that support android.hardware.touchscreen or a sub-feature are
1090 * presumed to also support faketouch.
1091 */
1092 @SdkConstant(SdkConstantType.FEATURE)
1093 public static final String FEATURE_FAKETOUCH = "android.hardware.faketouch";
1094
1095 /**
1096 * Feature for {@link #getSystemAvailableFeatures} and
Dianne Hackborne22fe932011-06-08 20:24:29 -07001097 * {@link #hasSystemFeature}: The device does not have a touch screen, but
1098 * does support touch emulation for basic events that supports distinct
1099 * tracking of two or more fingers. This is an extension of
1100 * {@link #FEATURE_FAKETOUCH} for input devices with this capability. Note
1101 * that unlike a distinct multitouch screen as defined by
1102 * {@link #FEATURE_TOUCHSCREEN_MULTITOUCH_DISTINCT}, these kinds of input
1103 * devices will not actually provide full two-finger gestures since the
1104 * input is being transformed to cursor movement on the screen. That is,
1105 * single finger gestures will move a cursor; two-finger swipes will
1106 * result in single-finger touch events; other two-finger gestures will
1107 * result in the corresponding two-finger touch event.
1108 */
1109 @SdkConstant(SdkConstantType.FEATURE)
1110 public static final String FEATURE_FAKETOUCH_MULTITOUCH_DISTINCT = "android.hardware.faketouch.multitouch.distinct";
1111
1112 /**
1113 * Feature for {@link #getSystemAvailableFeatures} and
1114 * {@link #hasSystemFeature}: The device does not have a touch screen, but
1115 * does support touch emulation for basic events that supports tracking
1116 * a hand of fingers (5 or more fingers) fully independently.
1117 * This is an extension of
1118 * {@link #FEATURE_FAKETOUCH} for input devices with this capability. Note
1119 * that unlike a multitouch screen as defined by
1120 * {@link #FEATURE_TOUCHSCREEN_MULTITOUCH_JAZZHAND}, not all two finger
1121 * gestures can be detected due to the limitations described for
1122 * {@link #FEATURE_FAKETOUCH_MULTITOUCH_DISTINCT}.
1123 */
1124 @SdkConstant(SdkConstantType.FEATURE)
1125 public static final String FEATURE_FAKETOUCH_MULTITOUCH_JAZZHAND = "android.hardware.faketouch.multitouch.jazzhand";
1126
1127 /**
1128 * Feature for {@link #getSystemAvailableFeatures} and
Dianne Hackborne289bff2011-06-13 19:33:22 -07001129 * {@link #hasSystemFeature}: The device supports portrait orientation
1130 * screens. For backwards compatibility, you can assume that if neither
1131 * this nor {@link #FEATURE_SCREEN_LANDSCAPE} is set then the device supports
1132 * both portrait and landscape.
1133 */
1134 @SdkConstant(SdkConstantType.FEATURE)
1135 public static final String FEATURE_SCREEN_PORTRAIT = "android.hardware.screen.portrait";
1136
1137 /**
1138 * Feature for {@link #getSystemAvailableFeatures} and
1139 * {@link #hasSystemFeature}: The device supports landscape orientation
1140 * screens. For backwards compatibility, you can assume that if neither
1141 * this nor {@link #FEATURE_SCREEN_PORTRAIT} is set then the device supports
1142 * both portrait and landscape.
1143 */
1144 @SdkConstant(SdkConstantType.FEATURE)
1145 public static final String FEATURE_SCREEN_LANDSCAPE = "android.hardware.screen.landscape";
1146
1147 /**
1148 * Feature for {@link #getSystemAvailableFeatures} and
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001149 * {@link #hasSystemFeature}: The device supports live wallpapers.
1150 */
Xavier Ducrohet3274b9b2009-12-14 17:52:20 -08001151 @SdkConstant(SdkConstantType.FEATURE)
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001152 public static final String FEATURE_LIVE_WALLPAPER = "android.software.live_wallpaper";
Oscar Montemayor1228d0a2010-01-28 12:01:44 -08001153
Oscar Montemayor1228d0a2010-01-28 12:01:44 -08001154 /**
Dan Morrill50ab63f2010-03-05 16:16:19 -08001155 * Feature for {@link #getSystemAvailableFeatures} and
Dianne Hackborn119bbc32013-03-22 17:27:25 -07001156 * {@link #hasSystemFeature}: The device supports app widgets.
1157 */
1158 @SdkConstant(SdkConstantType.FEATURE)
1159 public static final String FEATURE_APP_WIDGETS = "android.software.app_widgets";
1160
1161 /**
1162 * Feature for {@link #getSystemAvailableFeatures} and
1163 * {@link #hasSystemFeature}: The device supports a home screen that is replaceable
1164 * by third party applications.
1165 */
1166 @SdkConstant(SdkConstantType.FEATURE)
1167 public static final String FEATURE_HOME_SCREEN = "android.software.home_screen";
1168
1169 /**
1170 * Feature for {@link #getSystemAvailableFeatures} and
1171 * {@link #hasSystemFeature}: The device supports adding new input methods implemented
1172 * with the {@link android.inputmethodservice.InputMethodService} API.
1173 */
1174 @SdkConstant(SdkConstantType.FEATURE)
1175 public static final String FEATURE_INPUT_METHODS = "android.software.input_methods";
1176
1177 /**
1178 * Feature for {@link #getSystemAvailableFeatures} and
Dan Morrill50ab63f2010-03-05 16:16:19 -08001179 * {@link #hasSystemFeature}: The device supports WiFi (802.11) networking.
1180 */
1181 @SdkConstant(SdkConstantType.FEATURE)
1182 public static final String FEATURE_WIFI = "android.hardware.wifi";
1183
1184 /**
Irfan Sheriff45b8b462011-09-07 11:24:16 -07001185 * Feature for {@link #getSystemAvailableFeatures} and
1186 * {@link #hasSystemFeature}: The device supports Wi-Fi Direct networking.
1187 */
1188 @SdkConstant(SdkConstantType.FEATURE)
1189 public static final String FEATURE_WIFI_DIRECT = "android.hardware.wifi.direct";
1190
1191 /**
Dianne Hackborn0cf2c8a2012-05-17 17:29:49 -07001192 * Feature for {@link #getSystemAvailableFeatures} and
1193 * {@link #hasSystemFeature}: This is a device dedicated to showing UI
1194 * on a television. Television here is defined to be a typical living
1195 * room television experience: displayed on a big screen, where the user
1196 * is sitting far away from it, and the dominant form of input will be
1197 * something like a DPAD, not through touch or mouse.
1198 */
1199 @SdkConstant(SdkConstantType.FEATURE)
1200 public static final String FEATURE_TELEVISION = "android.hardware.type.television";
1201
1202 /**
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001203 * Action to external storage service to clean out removed apps.
1204 * @hide
1205 */
1206 public static final String ACTION_CLEAN_EXTERNAL_STORAGE
1207 = "android.content.pm.CLEAN_EXTERNAL_STORAGE";
Oscar Montemayor1228d0a2010-01-28 12:01:44 -08001208
Dianne Hackborn08ee42c2009-11-19 17:08:01 -08001209 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001210 * Extra field name for the URI to a verification file. Passed to a package
1211 * verifier.
1212 *
1213 * @hide
1214 */
1215 public static final String EXTRA_VERIFICATION_URI = "android.content.pm.extra.VERIFICATION_URI";
1216
1217 /**
1218 * Extra field name for the ID of a package pending verification. Passed to
1219 * a package verifier and is used to call back to
Kenny Root3a9b5fb2011-09-20 14:15:38 -07001220 * {@link PackageManager#verifyPendingInstall(int, int)}
Kenny Root5ab21572011-07-27 11:11:19 -07001221 */
1222 public static final String EXTRA_VERIFICATION_ID = "android.content.pm.extra.VERIFICATION_ID";
1223
1224 /**
1225 * Extra field name for the package identifier which is trying to install
1226 * the package.
1227 *
1228 * @hide
1229 */
1230 public static final String EXTRA_VERIFICATION_INSTALLER_PACKAGE
1231 = "android.content.pm.extra.VERIFICATION_INSTALLER_PACKAGE";
1232
1233 /**
1234 * Extra field name for the requested install flags for a package pending
1235 * verification. Passed to a package verifier.
1236 *
1237 * @hide
1238 */
1239 public static final String EXTRA_VERIFICATION_INSTALL_FLAGS
1240 = "android.content.pm.extra.VERIFICATION_INSTALL_FLAGS";
1241
1242 /**
rich cannings13d428e2012-09-13 13:43:07 -07001243 * Extra field name for the uid of who is requesting to install
1244 * the package.
1245 *
1246 * @hide
1247 */
1248 public static final String EXTRA_VERIFICATION_INSTALLER_UID
1249 = "android.content.pm.extra.VERIFICATION_INSTALLER_UID";
1250
1251 /**
1252 * Extra field name for the package name of a package pending verification.
1253 *
1254 * @hide
1255 */
1256 public static final String EXTRA_VERIFICATION_PACKAGE_NAME
1257 = "android.content.pm.extra.VERIFICATION_PACKAGE_NAME";
1258 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001259 * Extra field name for the result of a verification, either
1260 * {@link #VERIFICATION_ALLOW}, or {@link #VERIFICATION_REJECT}.
1261 * Passed to package verifiers after a package is verified.
1262 */
1263 public static final String EXTRA_VERIFICATION_RESULT
1264 = "android.content.pm.extra.VERIFICATION_RESULT";
1265
1266 /**
rich cannings13d428e2012-09-13 13:43:07 -07001267 * Extra field name for the version code of a package pending verification.
1268 *
1269 * @hide
1270 */
1271 public static final String EXTRA_VERIFICATION_VERSION_CODE
1272 = "android.content.pm.extra.VERIFICATION_VERSION_CODE";
1273
1274 /**
Nick Kralevich035f80d2013-03-27 15:20:08 -07001275 * The action used to request that the user approve a permission request
1276 * from the application.
1277 *
1278 * @hide
1279 */
1280 public static final String ACTION_REQUEST_PERMISSION
1281 = "android.content.pm.action.REQUEST_PERMISSION";
1282
1283 /**
1284 * Extra field name for the list of permissions, which the user must approve.
1285 *
1286 * @hide
1287 */
1288 public static final String EXTRA_REQUEST_PERMISSION_PERMISSION_LIST
1289 = "android.content.pm.extra.PERMISSION_LIST";
1290
1291 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001292 * Retrieve overall information about an application package that is
1293 * installed on the system.
Kenny Root5ab21572011-07-27 11:11:19 -07001294 * <p>
1295 * Throws {@link NameNotFoundException} if a package with the given name can
1296 * not be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001297 *
1298 * @param packageName The full name (i.e. com.google.apps.contacts) of the
Kenny Root5ab21572011-07-27 11:11:19 -07001299 * desired package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001300 * @param flags Additional option flags. Use any combination of
Kenny Root5ab21572011-07-27 11:11:19 -07001301 * {@link #GET_ACTIVITIES}, {@link #GET_GIDS},
1302 * {@link #GET_CONFIGURATIONS}, {@link #GET_INSTRUMENTATION},
1303 * {@link #GET_PERMISSIONS}, {@link #GET_PROVIDERS},
1304 * {@link #GET_RECEIVERS}, {@link #GET_SERVICES},
1305 * {@link #GET_SIGNATURES}, {@link #GET_UNINSTALLED_PACKAGES} to
1306 * modify the data returned.
1307 * @return Returns a PackageInfo object containing information about the
1308 * package. If flag GET_UNINSTALLED_PACKAGES is set and if the
1309 * package is not found in the list of installed applications, the
1310 * package information is retrieved from the list of uninstalled
kmccormick30498b42013-03-27 17:39:17 -07001311 * applications (which includes installed applications as well as
1312 * applications with data directory i.e. applications which had been
1313 * deleted with {@code DONT_DELETE_DATA} flag set).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001314 * @see #GET_ACTIVITIES
1315 * @see #GET_GIDS
1316 * @see #GET_CONFIGURATIONS
1317 * @see #GET_INSTRUMENTATION
1318 * @see #GET_PERMISSIONS
1319 * @see #GET_PROVIDERS
1320 * @see #GET_RECEIVERS
1321 * @see #GET_SERVICES
1322 * @see #GET_SIGNATURES
1323 * @see #GET_UNINSTALLED_PACKAGES
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001324 */
1325 public abstract PackageInfo getPackageInfo(String packageName, int flags)
1326 throws NameNotFoundException;
1327
1328 /**
Dianne Hackborn47096932010-02-11 15:57:09 -08001329 * Map from the current package names in use on the device to whatever
1330 * the current canonical name of that package is.
1331 * @param names Array of current names to be mapped.
1332 * @return Returns an array of the same size as the original, containing
1333 * the canonical name for each package.
1334 */
1335 public abstract String[] currentToCanonicalPackageNames(String[] names);
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001336
Dianne Hackborn47096932010-02-11 15:57:09 -08001337 /**
1338 * Map from a packages canonical name to the current name in use on the device.
1339 * @param names Array of new names to be mapped.
1340 * @return Returns an array of the same size as the original, containing
1341 * the current name for each package.
1342 */
1343 public abstract String[] canonicalToCurrentPackageNames(String[] names);
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001344
Dianne Hackborn47096932010-02-11 15:57:09 -08001345 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001346 * Return a "good" intent to launch a front-door activity in a package,
1347 * for use for example to implement an "open" button when browsing through
1348 * packages. The current implementation will look first for a main
1349 * activity in the category {@link Intent#CATEGORY_INFO}, next for a
1350 * main activity in the category {@link Intent#CATEGORY_LAUNCHER}, or return
1351 * null if neither are found.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001352 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001353 * <p>Throws {@link NameNotFoundException} if a package with the given
kmccormick30498b42013-03-27 17:39:17 -07001354 * name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001355 *
1356 * @param packageName The name of the package to inspect.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001357 *
Dianne Hackborn19415762010-12-15 00:20:27 -08001358 * @return Returns either a fully-qualified Intent that can be used to
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001359 * launch the main activity in the package, or null if the package does
1360 * not contain such an activity.
1361 */
Mihai Predaeae850c2009-05-13 10:13:48 +02001362 public abstract Intent getLaunchIntentForPackage(String packageName);
1363
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001364 /**
1365 * Return an array of all of the secondary group-ids that have been
1366 * assigned to a package.
1367 *
1368 * <p>Throws {@link NameNotFoundException} if a package with the given
kmccormick30498b42013-03-27 17:39:17 -07001369 * name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001370 *
1371 * @param packageName The full name (i.e. com.google.apps.contacts) of the
1372 * desired package.
1373 *
1374 * @return Returns an int array of the assigned gids, or null if there
1375 * are none.
1376 */
1377 public abstract int[] getPackageGids(String packageName)
1378 throws NameNotFoundException;
1379
1380 /**
Dianne Hackborna06de0f2012-12-11 16:34:47 -08001381 * @hide Return the uid associated with the given package name for the
1382 * given user.
1383 *
1384 * <p>Throws {@link NameNotFoundException} if a package with the given
1385 * name can not be found on the system.
1386 *
1387 * @param packageName The full name (i.e. com.google.apps.contacts) of the
1388 * desired package.
1389 * @param userHandle The user handle identifier to look up the package under.
1390 *
1391 * @return Returns an integer uid who owns the given package name.
1392 */
1393 public abstract int getPackageUid(String packageName, int userHandle)
1394 throws NameNotFoundException;
1395
1396 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001397 * Retrieve all of the information we know about a particular permission.
1398 *
1399 * <p>Throws {@link NameNotFoundException} if a permission with the given
kmccormick30498b42013-03-27 17:39:17 -07001400 * name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001401 *
1402 * @param name The fully qualified name (i.e. com.google.permission.LOGIN)
1403 * of the permission you are interested in.
1404 * @param flags Additional option flags. Use {@link #GET_META_DATA} to
1405 * retrieve any meta-data associated with the permission.
1406 *
1407 * @return Returns a {@link PermissionInfo} containing information about the
1408 * permission.
1409 */
1410 public abstract PermissionInfo getPermissionInfo(String name, int flags)
1411 throws NameNotFoundException;
1412
1413 /**
1414 * Query for all of the permissions associated with a particular group.
1415 *
1416 * <p>Throws {@link NameNotFoundException} if the given group does not
1417 * exist.
1418 *
1419 * @param group The fully qualified name (i.e. com.google.permission.LOGIN)
1420 * of the permission group you are interested in. Use null to
1421 * find all of the permissions not associated with a group.
1422 * @param flags Additional option flags. Use {@link #GET_META_DATA} to
1423 * retrieve any meta-data associated with the permissions.
1424 *
1425 * @return Returns a list of {@link PermissionInfo} containing information
1426 * about all of the permissions in the given group.
1427 */
1428 public abstract List<PermissionInfo> queryPermissionsByGroup(String group,
1429 int flags) throws NameNotFoundException;
1430
1431 /**
1432 * Retrieve all of the information we know about a particular group of
1433 * permissions.
1434 *
1435 * <p>Throws {@link NameNotFoundException} if a permission group with the given
kmccormick30498b42013-03-27 17:39:17 -07001436 * name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001437 *
1438 * @param name The fully qualified name (i.e. com.google.permission_group.APPS)
1439 * of the permission you are interested in.
1440 * @param flags Additional option flags. Use {@link #GET_META_DATA} to
1441 * retrieve any meta-data associated with the permission group.
1442 *
1443 * @return Returns a {@link PermissionGroupInfo} containing information
1444 * about the permission.
1445 */
1446 public abstract PermissionGroupInfo getPermissionGroupInfo(String name,
1447 int flags) throws NameNotFoundException;
1448
1449 /**
1450 * Retrieve all of the known permission groups in the system.
1451 *
1452 * @param flags Additional option flags. Use {@link #GET_META_DATA} to
1453 * retrieve any meta-data associated with the permission group.
1454 *
1455 * @return Returns a list of {@link PermissionGroupInfo} containing
1456 * information about all of the known permission groups.
1457 */
1458 public abstract List<PermissionGroupInfo> getAllPermissionGroups(int flags);
1459
1460 /**
1461 * Retrieve all of the information we know about a particular
1462 * package/application.
1463 *
1464 * <p>Throws {@link NameNotFoundException} if an application with the given
kmccormick30498b42013-03-27 17:39:17 -07001465 * package name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001466 *
1467 * @param packageName The full name (i.e. com.google.apps.contacts) of an
1468 * application.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001469 * @param flags Additional option flags. Use any combination of
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001470 * {@link #GET_META_DATA}, {@link #GET_SHARED_LIBRARY_FILES},
1471 * {@link #GET_UNINSTALLED_PACKAGES} to modify the data returned.
1472 *
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001473 * @return {@link ApplicationInfo} Returns ApplicationInfo object containing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001474 * information about the package.
1475 * If flag GET_UNINSTALLED_PACKAGES is set and if the package is not
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001476 * found in the list of installed applications,
1477 * the application information is retrieved from the
1478 * list of uninstalled applications(which includes
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001479 * installed applications as well as applications
1480 * with data directory ie applications which had been
kmccormick30498b42013-03-27 17:39:17 -07001481 * deleted with {@code DONT_DELETE_DATA} flag set).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001482 *
1483 * @see #GET_META_DATA
1484 * @see #GET_SHARED_LIBRARY_FILES
1485 * @see #GET_UNINSTALLED_PACKAGES
1486 */
1487 public abstract ApplicationInfo getApplicationInfo(String packageName,
1488 int flags) throws NameNotFoundException;
1489
1490 /**
1491 * Retrieve all of the information we know about a particular activity
1492 * class.
1493 *
1494 * <p>Throws {@link NameNotFoundException} if an activity with the given
kmccormick30498b42013-03-27 17:39:17 -07001495 * class name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001496 *
Dianne Hackborn361199b2010-08-30 17:42:07 -07001497 * @param component The full component name (i.e.
1498 * com.google.apps.contacts/com.google.apps.contacts.ContactsList) of an Activity
1499 * class.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001500 * @param flags Additional option flags. Use any combination of
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001501 * {@link #GET_META_DATA}, {@link #GET_SHARED_LIBRARY_FILES},
1502 * to modify the data (in ApplicationInfo) returned.
1503 *
1504 * @return {@link ActivityInfo} containing information about the activity.
1505 *
1506 * @see #GET_INTENT_FILTERS
1507 * @see #GET_META_DATA
1508 * @see #GET_SHARED_LIBRARY_FILES
1509 */
Dianne Hackborn361199b2010-08-30 17:42:07 -07001510 public abstract ActivityInfo getActivityInfo(ComponentName component,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001511 int flags) throws NameNotFoundException;
1512
1513 /**
1514 * Retrieve all of the information we know about a particular receiver
1515 * class.
1516 *
1517 * <p>Throws {@link NameNotFoundException} if a receiver with the given
kmccormick30498b42013-03-27 17:39:17 -07001518 * class name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001519 *
Dianne Hackborn361199b2010-08-30 17:42:07 -07001520 * @param component The full component name (i.e.
1521 * com.google.apps.calendar/com.google.apps.calendar.CalendarAlarm) of a Receiver
1522 * class.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001523 * @param flags Additional option flags. Use any combination of
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001524 * {@link #GET_META_DATA}, {@link #GET_SHARED_LIBRARY_FILES},
1525 * to modify the data returned.
1526 *
1527 * @return {@link ActivityInfo} containing information about the receiver.
1528 *
1529 * @see #GET_INTENT_FILTERS
1530 * @see #GET_META_DATA
1531 * @see #GET_SHARED_LIBRARY_FILES
1532 */
Dianne Hackborn361199b2010-08-30 17:42:07 -07001533 public abstract ActivityInfo getReceiverInfo(ComponentName component,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001534 int flags) throws NameNotFoundException;
1535
1536 /**
1537 * Retrieve all of the information we know about a particular service
1538 * class.
1539 *
1540 * <p>Throws {@link NameNotFoundException} if a service with the given
kmccormick30498b42013-03-27 17:39:17 -07001541 * class name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001542 *
Dianne Hackborn361199b2010-08-30 17:42:07 -07001543 * @param component The full component name (i.e.
1544 * com.google.apps.media/com.google.apps.media.BackgroundPlayback) of a Service
1545 * class.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001546 * @param flags Additional option flags. Use any combination of
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001547 * {@link #GET_META_DATA}, {@link #GET_SHARED_LIBRARY_FILES},
1548 * to modify the data returned.
1549 *
1550 * @return ServiceInfo containing information about the service.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001551 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001552 * @see #GET_META_DATA
1553 * @see #GET_SHARED_LIBRARY_FILES
1554 */
Dianne Hackborn361199b2010-08-30 17:42:07 -07001555 public abstract ServiceInfo getServiceInfo(ComponentName component,
1556 int flags) throws NameNotFoundException;
1557
1558 /**
1559 * Retrieve all of the information we know about a particular content
1560 * provider class.
1561 *
1562 * <p>Throws {@link NameNotFoundException} if a provider with the given
kmccormick30498b42013-03-27 17:39:17 -07001563 * class name cannot be found on the system.
Dianne Hackborn361199b2010-08-30 17:42:07 -07001564 *
1565 * @param component The full component name (i.e.
1566 * com.google.providers.media/com.google.providers.media.MediaProvider) of a
1567 * ContentProvider class.
1568 * @param flags Additional option flags. Use any combination of
1569 * {@link #GET_META_DATA}, {@link #GET_SHARED_LIBRARY_FILES},
1570 * to modify the data returned.
1571 *
1572 * @return ProviderInfo containing information about the service.
1573 *
1574 * @see #GET_META_DATA
1575 * @see #GET_SHARED_LIBRARY_FILES
1576 */
1577 public abstract ProviderInfo getProviderInfo(ComponentName component,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001578 int flags) throws NameNotFoundException;
1579
1580 /**
1581 * Return a List of all packages that are installed
1582 * on the device.
1583 *
1584 * @param flags Additional option flags. Use any combination of
1585 * {@link #GET_ACTIVITIES},
1586 * {@link #GET_GIDS},
1587 * {@link #GET_CONFIGURATIONS},
1588 * {@link #GET_INSTRUMENTATION},
1589 * {@link #GET_PERMISSIONS},
1590 * {@link #GET_PROVIDERS},
1591 * {@link #GET_RECEIVERS},
1592 * {@link #GET_SERVICES},
1593 * {@link #GET_SIGNATURES},
1594 * {@link #GET_UNINSTALLED_PACKAGES} to modify the data returned.
1595 *
1596 * @return A List of PackageInfo objects, one for each package that is
1597 * installed on the device. In the unlikely case of there being no
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001598 * installed packages, an empty list is returned.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001599 * If flag GET_UNINSTALLED_PACKAGES is set, a list of all
kmccormick30498b42013-03-27 17:39:17 -07001600 * applications including those deleted with {@code DONT_DELETE_DATA}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001601 * (partially installed apps with data directory) will be returned.
1602 *
1603 * @see #GET_ACTIVITIES
1604 * @see #GET_GIDS
1605 * @see #GET_CONFIGURATIONS
1606 * @see #GET_INSTRUMENTATION
1607 * @see #GET_PERMISSIONS
1608 * @see #GET_PROVIDERS
1609 * @see #GET_RECEIVERS
1610 * @see #GET_SERVICES
1611 * @see #GET_SIGNATURES
1612 * @see #GET_UNINSTALLED_PACKAGES
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001613 */
1614 public abstract List<PackageInfo> getInstalledPackages(int flags);
1615
1616 /**
Dianne Hackborne7991752013-01-16 17:56:46 -08001617 * Return a List of all installed packages that are currently
1618 * holding any of the given permissions.
1619 *
1620 * @param flags Additional option flags. Use any combination of
1621 * {@link #GET_ACTIVITIES},
1622 * {@link #GET_GIDS},
1623 * {@link #GET_CONFIGURATIONS},
1624 * {@link #GET_INSTRUMENTATION},
1625 * {@link #GET_PERMISSIONS},
1626 * {@link #GET_PROVIDERS},
1627 * {@link #GET_RECEIVERS},
1628 * {@link #GET_SERVICES},
1629 * {@link #GET_SIGNATURES},
1630 * {@link #GET_UNINSTALLED_PACKAGES} to modify the data returned.
1631 *
1632 * @return Returns a List of PackageInfo objects, one for each installed
1633 * application that is holding any of the permissions that were provided.
1634 *
1635 * @see #GET_ACTIVITIES
1636 * @see #GET_GIDS
1637 * @see #GET_CONFIGURATIONS
1638 * @see #GET_INSTRUMENTATION
1639 * @see #GET_PERMISSIONS
1640 * @see #GET_PROVIDERS
1641 * @see #GET_RECEIVERS
1642 * @see #GET_SERVICES
1643 * @see #GET_SIGNATURES
1644 * @see #GET_UNINSTALLED_PACKAGES
1645 */
1646 public abstract List<PackageInfo> getPackagesHoldingPermissions(
1647 String[] permissions, int flags);
1648
1649 /**
Amith Yamasani151ec4c2012-09-07 19:25:16 -07001650 * Return a List of all packages that are installed on the device, for a specific user.
1651 * Requesting a list of installed packages for another user
1652 * will require the permission INTERACT_ACROSS_USERS_FULL.
1653 * @param flags Additional option flags. Use any combination of
1654 * {@link #GET_ACTIVITIES},
1655 * {@link #GET_GIDS},
1656 * {@link #GET_CONFIGURATIONS},
1657 * {@link #GET_INSTRUMENTATION},
1658 * {@link #GET_PERMISSIONS},
1659 * {@link #GET_PROVIDERS},
1660 * {@link #GET_RECEIVERS},
1661 * {@link #GET_SERVICES},
1662 * {@link #GET_SIGNATURES},
1663 * {@link #GET_UNINSTALLED_PACKAGES} to modify the data returned.
1664 * @param userId The user for whom the installed packages are to be listed
1665 *
1666 * @return A List of PackageInfo objects, one for each package that is
1667 * installed on the device. In the unlikely case of there being no
1668 * installed packages, an empty list is returned.
1669 * If flag GET_UNINSTALLED_PACKAGES is set, a list of all
kmccormick30498b42013-03-27 17:39:17 -07001670 * applications including those deleted with {@code DONT_DELETE_DATA}
Amith Yamasani151ec4c2012-09-07 19:25:16 -07001671 * (partially installed apps with data directory) will be returned.
1672 *
1673 * @see #GET_ACTIVITIES
1674 * @see #GET_GIDS
1675 * @see #GET_CONFIGURATIONS
1676 * @see #GET_INSTRUMENTATION
1677 * @see #GET_PERMISSIONS
1678 * @see #GET_PROVIDERS
1679 * @see #GET_RECEIVERS
1680 * @see #GET_SERVICES
1681 * @see #GET_SIGNATURES
1682 * @see #GET_UNINSTALLED_PACKAGES
1683 *
1684 * @hide
1685 */
1686 public abstract List<PackageInfo> getInstalledPackages(int flags, int userId);
1687
1688 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001689 * Check whether a particular package has been granted a particular
1690 * permission.
1691 *
1692 * @param permName The name of the permission you are checking for,
1693 * @param pkgName The name of the package you are checking against.
1694 *
1695 * @return If the package has the permission, PERMISSION_GRANTED is
1696 * returned. If it does not have the permission, PERMISSION_DENIED
1697 * is returned.
1698 *
1699 * @see #PERMISSION_GRANTED
1700 * @see #PERMISSION_DENIED
1701 */
1702 public abstract int checkPermission(String permName, String pkgName);
1703
1704 /**
1705 * Add a new dynamic permission to the system. For this to work, your
1706 * package must have defined a permission tree through the
1707 * {@link android.R.styleable#AndroidManifestPermissionTree
1708 * &lt;permission-tree&gt;} tag in its manifest. A package can only add
1709 * permissions to trees that were defined by either its own package or
1710 * another with the same user id; a permission is in a tree if it
1711 * matches the name of the permission tree + ".": for example,
1712 * "com.foo.bar" is a member of the permission tree "com.foo".
1713 *
1714 * <p>It is good to make your permission tree name descriptive, because you
1715 * are taking possession of that entire set of permission names. Thus, it
1716 * must be under a domain you control, with a suffix that will not match
1717 * any normal permissions that may be declared in any applications that
1718 * are part of that domain.
1719 *
1720 * <p>New permissions must be added before
1721 * any .apks are installed that use those permissions. Permissions you
1722 * add through this method are remembered across reboots of the device.
1723 * If the given permission already exists, the info you supply here
1724 * will be used to update it.
1725 *
1726 * @param info Description of the permission to be added.
1727 *
1728 * @return Returns true if a new permission was created, false if an
1729 * existing one was updated.
1730 *
1731 * @throws SecurityException if you are not allowed to add the
1732 * given permission name.
1733 *
1734 * @see #removePermission(String)
1735 */
1736 public abstract boolean addPermission(PermissionInfo info);
1737
1738 /**
Dianne Hackbornd7c09682010-03-30 10:42:20 -07001739 * Like {@link #addPermission(PermissionInfo)} but asynchronously
1740 * persists the package manager state after returning from the call,
1741 * allowing it to return quicker and batch a series of adds at the
1742 * expense of no guarantee the added permission will be retained if
1743 * the device is rebooted before it is written.
1744 */
1745 public abstract boolean addPermissionAsync(PermissionInfo info);
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001746
Dianne Hackbornd7c09682010-03-30 10:42:20 -07001747 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001748 * Removes a permission that was previously added with
1749 * {@link #addPermission(PermissionInfo)}. The same ownership rules apply
1750 * -- you are only allowed to remove permissions that you are allowed
1751 * to add.
1752 *
1753 * @param name The name of the permission to remove.
1754 *
1755 * @throws SecurityException if you are not allowed to remove the
1756 * given permission name.
1757 *
1758 * @see #addPermission(PermissionInfo)
1759 */
1760 public abstract void removePermission(String name);
1761
1762 /**
Nick Kralevich035f80d2013-03-27 15:20:08 -07001763 * Returns an {@link Intent} suitable for passing to {@code startActivityForResult}
1764 * which prompts the user to grant {@code permissions} to this application.
Nick Kralevich32eb5b182013-04-11 10:20:09 -07001765 * @hide
Nick Kralevich035f80d2013-03-27 15:20:08 -07001766 *
1767 * @throws NullPointerException if {@code permissions} is {@code null}.
1768 * @throws IllegalArgumentException if {@code permissions} contains {@code null}.
1769 */
1770 public Intent buildPermissionRequestIntent(String... permissions) {
1771 if (permissions == null) {
1772 throw new NullPointerException("permissions cannot be null");
1773 }
1774 for (String permission : permissions) {
1775 if (permission == null) {
1776 throw new IllegalArgumentException("permissions cannot contain null");
1777 }
1778 }
1779
1780 Intent i = new Intent(ACTION_REQUEST_PERMISSION);
1781 i.putExtra(EXTRA_REQUEST_PERMISSION_PERMISSION_LIST, permissions);
1782 i.setPackage("com.android.packageinstaller");
1783 return i;
1784 }
1785
1786 /**
Dianne Hackborne639da72012-02-21 15:11:13 -08001787 * Grant a permission to an application which the application does not
1788 * already have. The permission must have been requested by the application,
1789 * but as an optional permission. If the application is not allowed to
1790 * hold the permission, a SecurityException is thrown.
1791 * @hide
1792 *
1793 * @param packageName The name of the package that the permission will be
1794 * granted to.
1795 * @param permissionName The name of the permission.
1796 */
1797 public abstract void grantPermission(String packageName, String permissionName);
1798
1799 /**
1800 * Revoke a permission that was previously granted by {@link #grantPermission}.
1801 * @hide
1802 *
1803 * @param packageName The name of the package that the permission will be
1804 * granted to.
1805 * @param permissionName The name of the permission.
1806 */
1807 public abstract void revokePermission(String packageName, String permissionName);
1808
1809 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001810 * Compare the signatures of two packages to determine if the same
1811 * signature appears in both of them. If they do contain the same
1812 * signature, then they are allowed special privileges when working
1813 * with each other: they can share the same user-id, run instrumentation
1814 * against each other, etc.
1815 *
1816 * @param pkg1 First package name whose signature will be compared.
1817 * @param pkg2 Second package name whose signature will be compared.
Chris Palmer09f33602010-09-13 14:27:18 -07001818 *
1819 * @return Returns an integer indicating whether all signatures on the
1820 * two packages match. The value is >= 0 ({@link #SIGNATURE_MATCH}) if
1821 * all signatures match or < 0 if there is not a match ({@link
1822 * #SIGNATURE_NO_MATCH} or {@link #SIGNATURE_UNKNOWN_PACKAGE}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001823 *
Dianne Hackborn766cbfe2009-08-12 18:33:39 -07001824 * @see #checkSignatures(int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001825 * @see #SIGNATURE_MATCH
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001826 * @see #SIGNATURE_NO_MATCH
1827 * @see #SIGNATURE_UNKNOWN_PACKAGE
1828 */
1829 public abstract int checkSignatures(String pkg1, String pkg2);
1830
1831 /**
Dianne Hackborn766cbfe2009-08-12 18:33:39 -07001832 * Like {@link #checkSignatures(String, String)}, but takes UIDs of
1833 * the two packages to be checked. This can be useful, for example,
1834 * when doing the check in an IPC, where the UID is the only identity
1835 * available. It is functionally identical to determining the package
1836 * associated with the UIDs and checking their signatures.
1837 *
Joe Onorato25660ec2009-08-12 22:40:37 -07001838 * @param uid1 First UID whose signature will be compared.
1839 * @param uid2 Second UID whose signature will be compared.
Dianne Hackborn766cbfe2009-08-12 18:33:39 -07001840 *
Chris Palmer09f33602010-09-13 14:27:18 -07001841 * @return Returns an integer indicating whether all signatures on the
1842 * two packages match. The value is >= 0 ({@link #SIGNATURE_MATCH}) if
1843 * all signatures match or < 0 if there is not a match ({@link
1844 * #SIGNATURE_NO_MATCH} or {@link #SIGNATURE_UNKNOWN_PACKAGE}).
1845 *
1846 * @see #checkSignatures(String, String)
Dianne Hackborn766cbfe2009-08-12 18:33:39 -07001847 * @see #SIGNATURE_MATCH
Dianne Hackborn766cbfe2009-08-12 18:33:39 -07001848 * @see #SIGNATURE_NO_MATCH
1849 * @see #SIGNATURE_UNKNOWN_PACKAGE
1850 */
1851 public abstract int checkSignatures(int uid1, int uid2);
1852
1853 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001854 * Retrieve the names of all packages that are associated with a particular
1855 * user id. In most cases, this will be a single package name, the package
1856 * that has been assigned that user id. Where there are multiple packages
1857 * sharing the same user id through the "sharedUserId" mechanism, all
1858 * packages with that id will be returned.
1859 *
1860 * @param uid The user id for which you would like to retrieve the
1861 * associated packages.
1862 *
1863 * @return Returns an array of one or more packages assigned to the user
1864 * id, or null if there are no known packages with the given id.
1865 */
1866 public abstract String[] getPackagesForUid(int uid);
1867
1868 /**
1869 * Retrieve the official name associated with a user id. This name is
1870 * guaranteed to never change, though it is possibly for the underlying
1871 * user id to be changed. That is, if you are storing information about
1872 * user ids in persistent storage, you should use the string returned
1873 * by this function instead of the raw user-id.
1874 *
1875 * @param uid The user id for which you would like to retrieve a name.
1876 * @return Returns a unique name for the given user id, or null if the
1877 * user id is not currently assigned.
1878 */
1879 public abstract String getNameForUid(int uid);
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001880
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001881 /**
1882 * Return the user id associated with a shared user name. Multiple
1883 * applications can specify a shared user name in their manifest and thus
1884 * end up using a common uid. This might be used for new applications
1885 * that use an existing shared user name and need to know the uid of the
1886 * shared user.
1887 *
1888 * @param sharedUserName The shared user name whose uid is to be retrieved.
1889 * @return Returns the uid associated with the shared user, or NameNotFoundException
1890 * if the shared user name is not being used by any installed packages
1891 * @hide
1892 */
1893 public abstract int getUidForSharedUser(String sharedUserName)
1894 throws NameNotFoundException;
1895
1896 /**
1897 * Return a List of all application packages that are installed on the
1898 * device. If flag GET_UNINSTALLED_PACKAGES has been set, a list of all
kmccormick30498b42013-03-27 17:39:17 -07001899 * applications including those deleted with {@code DONT_DELETE_DATA} (partially
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001900 * installed apps with data directory) will be returned.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001901 *
1902 * @param flags Additional option flags. Use any combination of
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001903 * {@link #GET_META_DATA}, {@link #GET_SHARED_LIBRARY_FILES},
Jeff Smitha45746e2012-07-19 14:19:24 -05001904 * {@link #GET_UNINSTALLED_PACKAGES} to modify the data returned.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001905 *
Dianne Hackborne7991752013-01-16 17:56:46 -08001906 * @return Returns a List of ApplicationInfo objects, one for each application that
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001907 * is installed on the device. In the unlikely case of there being
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001908 * no installed applications, an empty list is returned.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001909 * If flag GET_UNINSTALLED_PACKAGES is set, a list of all
kmccormick30498b42013-03-27 17:39:17 -07001910 * applications including those deleted with {@code DONT_DELETE_DATA}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001911 * (partially installed apps with data directory) will be returned.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001912 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001913 * @see #GET_META_DATA
1914 * @see #GET_SHARED_LIBRARY_FILES
1915 * @see #GET_UNINSTALLED_PACKAGES
1916 */
1917 public abstract List<ApplicationInfo> getInstalledApplications(int flags);
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001918
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001919 /**
1920 * Get a list of shared libraries that are available on the
1921 * system.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001922 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001923 * @return An array of shared library names that are
1924 * available on the system, or null if none are installed.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001925 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001926 */
1927 public abstract String[] getSystemSharedLibraryNames();
1928
1929 /**
Dianne Hackborn49237342009-08-27 20:08:01 -07001930 * Get a list of features that are available on the
1931 * system.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001932 *
Dianne Hackborn49237342009-08-27 20:08:01 -07001933 * @return An array of FeatureInfo classes describing the features
1934 * that are available on the system, or null if there are none(!!).
Dianne Hackborn49237342009-08-27 20:08:01 -07001935 */
1936 public abstract FeatureInfo[] getSystemAvailableFeatures();
1937
1938 /**
Dianne Hackborn039c68e2009-09-26 16:39:23 -07001939 * Check whether the given feature name is one of the available
1940 * features as returned by {@link #getSystemAvailableFeatures()}.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001941 *
Dianne Hackborn039c68e2009-09-26 16:39:23 -07001942 * @return Returns true if the devices supports the feature, else
1943 * false.
1944 */
1945 public abstract boolean hasSystemFeature(String name);
1946
1947 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001948 * Determine the best action to perform for a given Intent. This is how
1949 * {@link Intent#resolveActivity} finds an activity if a class has not
1950 * been explicitly specified.
1951 *
Scott Mainef6b3052011-03-23 14:23:02 -07001952 * <p><em>Note:</em> if using an implicit Intent (without an explicit ComponentName
Dianne Hackborn4d023d212010-10-01 13:41:04 -07001953 * specified), be sure to consider whether to set the {@link #MATCH_DEFAULT_ONLY}
1954 * only flag. You need to do so to resolve the activity in the same way
1955 * that {@link android.content.Context#startActivity(Intent)} and
1956 * {@link android.content.Intent#resolveActivity(PackageManager)
1957 * Intent.resolveActivity(PackageManager)} do.</p>
Amith Yamasani4b2e9342011-03-31 12:38:53 -07001958 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001959 * @param intent An intent containing all of the desired specification
1960 * (action, data, type, category, and/or component).
1961 * @param flags Additional option flags. The most important is
Dianne Hackborn4d023d212010-10-01 13:41:04 -07001962 * {@link #MATCH_DEFAULT_ONLY}, to limit the resolution to only
1963 * those activities that support the {@link android.content.Intent#CATEGORY_DEFAULT}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001964 *
1965 * @return Returns a ResolveInfo containing the final activity intent that
1966 * was determined to be the best action. Returns null if no
Mike LeBeaubd3f5272010-02-18 19:27:17 -08001967 * matching activity was found. If multiple matching activities are
1968 * found and there is no default set, returns a ResolveInfo
1969 * containing something else, such as the activity resolver.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001970 *
1971 * @see #MATCH_DEFAULT_ONLY
1972 * @see #GET_INTENT_FILTERS
1973 * @see #GET_RESOLVED_FILTER
1974 */
1975 public abstract ResolveInfo resolveActivity(Intent intent, int flags);
1976
1977 /**
Svetoslav Ganov58d37b52012-09-18 12:04:19 -07001978 * Determine the best action to perform for a given Intent for a given user. This
1979 * is how {@link Intent#resolveActivity} finds an activity if a class has not
1980 * been explicitly specified.
1981 *
1982 * <p><em>Note:</em> if using an implicit Intent (without an explicit ComponentName
1983 * specified), be sure to consider whether to set the {@link #MATCH_DEFAULT_ONLY}
1984 * only flag. You need to do so to resolve the activity in the same way
1985 * that {@link android.content.Context#startActivity(Intent)} and
1986 * {@link android.content.Intent#resolveActivity(PackageManager)
1987 * Intent.resolveActivity(PackageManager)} do.</p>
1988 *
1989 * @param intent An intent containing all of the desired specification
1990 * (action, data, type, category, and/or component).
1991 * @param flags Additional option flags. The most important is
1992 * {@link #MATCH_DEFAULT_ONLY}, to limit the resolution to only
1993 * those activities that support the {@link android.content.Intent#CATEGORY_DEFAULT}.
1994 * @param userId The user id.
1995 *
1996 * @return Returns a ResolveInfo containing the final activity intent that
1997 * was determined to be the best action. Returns null if no
1998 * matching activity was found. If multiple matching activities are
1999 * found and there is no default set, returns a ResolveInfo
2000 * containing something else, such as the activity resolver.
2001 *
2002 * @see #MATCH_DEFAULT_ONLY
2003 * @see #GET_INTENT_FILTERS
2004 * @see #GET_RESOLVED_FILTER
2005 *
2006 * @hide
2007 */
2008 public abstract ResolveInfo resolveActivityAsUser(Intent intent, int flags, int userId);
2009
2010 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002011 * Retrieve all activities that can be performed for the given intent.
2012 *
2013 * @param intent The desired intent as per resolveActivity().
2014 * @param flags Additional option flags. The most important is
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002015 * {@link #MATCH_DEFAULT_ONLY}, to limit the resolution to only
2016 * those activities that support the {@link android.content.Intent#CATEGORY_DEFAULT}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002017 *
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002018 * @return A List&lt;ResolveInfo&gt; containing one entry for each matching
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002019 * Activity. These are ordered from best to worst match -- that
2020 * is, the first item in the list is what is returned by
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002021 * {@link #resolveActivity}. If there are no matching activities, an empty
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002022 * list is returned.
2023 *
2024 * @see #MATCH_DEFAULT_ONLY
2025 * @see #GET_INTENT_FILTERS
2026 * @see #GET_RESOLVED_FILTER
2027 */
2028 public abstract List<ResolveInfo> queryIntentActivities(Intent intent,
2029 int flags);
2030
2031 /**
Amith Yamasani151ec4c2012-09-07 19:25:16 -07002032 * Retrieve all activities that can be performed for the given intent, for a specific user.
2033 *
2034 * @param intent The desired intent as per resolveActivity().
2035 * @param flags Additional option flags. The most important is
2036 * {@link #MATCH_DEFAULT_ONLY}, to limit the resolution to only
2037 * those activities that support the {@link android.content.Intent#CATEGORY_DEFAULT}.
2038 *
2039 * @return A List&lt;ResolveInfo&gt; containing one entry for each matching
2040 * Activity. These are ordered from best to worst match -- that
2041 * is, the first item in the list is what is returned by
2042 * {@link #resolveActivity}. If there are no matching activities, an empty
2043 * list is returned.
2044 *
2045 * @see #MATCH_DEFAULT_ONLY
2046 * @see #GET_INTENT_FILTERS
2047 * @see #GET_RESOLVED_FILTER
2048 * @hide
2049 */
Svetoslav Ganov58d37b52012-09-18 12:04:19 -07002050 public abstract List<ResolveInfo> queryIntentActivitiesAsUser(Intent intent,
Amith Yamasani151ec4c2012-09-07 19:25:16 -07002051 int flags, int userId);
2052
2053
2054 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002055 * Retrieve a set of activities that should be presented to the user as
2056 * similar options. This is like {@link #queryIntentActivities}, except it
2057 * also allows you to supply a list of more explicit Intents that you would
2058 * like to resolve to particular options, and takes care of returning the
2059 * final ResolveInfo list in a reasonable order, with no duplicates, based
2060 * on those inputs.
2061 *
2062 * @param caller The class name of the activity that is making the
2063 * request. This activity will never appear in the output
2064 * list. Can be null.
2065 * @param specifics An array of Intents that should be resolved to the
2066 * first specific results. Can be null.
2067 * @param intent The desired intent as per resolveActivity().
2068 * @param flags Additional option flags. The most important is
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002069 * {@link #MATCH_DEFAULT_ONLY}, to limit the resolution to only
2070 * those activities that support the {@link android.content.Intent#CATEGORY_DEFAULT}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002071 *
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002072 * @return A List&lt;ResolveInfo&gt; containing one entry for each matching
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002073 * Activity. These are ordered first by all of the intents resolved
2074 * in <var>specifics</var> and then any additional activities that
2075 * can handle <var>intent</var> but did not get included by one of
2076 * the <var>specifics</var> intents. If there are no matching
2077 * activities, an empty list is returned.
2078 *
2079 * @see #MATCH_DEFAULT_ONLY
2080 * @see #GET_INTENT_FILTERS
2081 * @see #GET_RESOLVED_FILTER
2082 */
2083 public abstract List<ResolveInfo> queryIntentActivityOptions(
2084 ComponentName caller, Intent[] specifics, Intent intent, int flags);
2085
2086 /**
2087 * Retrieve all receivers that can handle a broadcast of the given intent.
2088 *
2089 * @param intent The desired intent as per resolveActivity().
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002090 * @param flags Additional option flags.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002091 *
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002092 * @return A List&lt;ResolveInfo&gt; containing one entry for each matching
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002093 * Receiver. These are ordered from first to last in priority. If
2094 * there are no matching receivers, an empty list is returned.
2095 *
2096 * @see #MATCH_DEFAULT_ONLY
2097 * @see #GET_INTENT_FILTERS
2098 * @see #GET_RESOLVED_FILTER
2099 */
2100 public abstract List<ResolveInfo> queryBroadcastReceivers(Intent intent,
2101 int flags);
2102
2103 /**
Amith Yamasanif203aee2012-08-29 18:41:53 -07002104 * Retrieve all receivers that can handle a broadcast of the given intent, for a specific
2105 * user.
2106 *
2107 * @param intent The desired intent as per resolveActivity().
2108 * @param flags Additional option flags.
2109 * @param userId The userId of the user being queried.
2110 *
2111 * @return A List&lt;ResolveInfo&gt; containing one entry for each matching
2112 * Receiver. These are ordered from first to last in priority. If
2113 * there are no matching receivers, an empty list is returned.
2114 *
2115 * @see #MATCH_DEFAULT_ONLY
2116 * @see #GET_INTENT_FILTERS
2117 * @see #GET_RESOLVED_FILTER
2118 * @hide
2119 */
2120 public abstract List<ResolveInfo> queryBroadcastReceivers(Intent intent,
2121 int flags, int userId);
2122
2123 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002124 * Determine the best service to handle for a given Intent.
2125 *
2126 * @param intent An intent containing all of the desired specification
2127 * (action, data, type, category, and/or component).
2128 * @param flags Additional option flags.
2129 *
2130 * @return Returns a ResolveInfo containing the final service intent that
2131 * was determined to be the best action. Returns null if no
2132 * matching service was found.
2133 *
2134 * @see #GET_INTENT_FILTERS
2135 * @see #GET_RESOLVED_FILTER
2136 */
2137 public abstract ResolveInfo resolveService(Intent intent, int flags);
2138
2139 /**
2140 * Retrieve all services that can match the given intent.
2141 *
2142 * @param intent The desired intent as per resolveService().
2143 * @param flags Additional option flags.
2144 *
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002145 * @return A List&lt;ResolveInfo&gt; containing one entry for each matching
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002146 * ServiceInfo. These are ordered from best to worst match -- that
2147 * is, the first item in the list is what is returned by
2148 * resolveService(). If there are no matching services, an empty
2149 * list is returned.
2150 *
2151 * @see #GET_INTENT_FILTERS
2152 * @see #GET_RESOLVED_FILTER
2153 */
2154 public abstract List<ResolveInfo> queryIntentServices(Intent intent,
2155 int flags);
2156
2157 /**
Svetoslav Ganov58d37b52012-09-18 12:04:19 -07002158 * Retrieve all services that can match the given intent for a given user.
2159 *
2160 * @param intent The desired intent as per resolveService().
2161 * @param flags Additional option flags.
2162 * @param userId The user id.
2163 *
2164 * @return A List&lt;ResolveInfo&gt; containing one entry for each matching
2165 * ServiceInfo. These are ordered from best to worst match -- that
2166 * is, the first item in the list is what is returned by
2167 * resolveService(). If there are no matching services, an empty
2168 * list is returned.
2169 *
2170 * @see #GET_INTENT_FILTERS
2171 * @see #GET_RESOLVED_FILTER
2172 *
2173 * @hide
2174 */
2175 public abstract List<ResolveInfo> queryIntentServicesAsUser(Intent intent,
2176 int flags, int userId);
2177
2178 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 * Find a single content provider by its base path name.
2180 *
2181 * @param name The name of the provider to find.
2182 * @param flags Additional option flags. Currently should always be 0.
2183 *
2184 * @return ContentProviderInfo Information about the provider, if found,
2185 * else null.
2186 */
2187 public abstract ProviderInfo resolveContentProvider(String name,
2188 int flags);
2189
2190 /**
2191 * Retrieve content provider information.
2192 *
2193 * <p><em>Note: unlike most other methods, an empty result set is indicated
2194 * by a null return instead of an empty list.</em>
2195 *
2196 * @param processName If non-null, limits the returned providers to only
2197 * those that are hosted by the given process. If null,
2198 * all content providers are returned.
2199 * @param uid If <var>processName</var> is non-null, this is the required
2200 * uid owning the requested content providers.
2201 * @param flags Additional option flags. Currently should always be 0.
2202 *
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002203 * @return A List&lt;ContentProviderInfo&gt; containing one entry for each
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002204 * content provider either patching <var>processName</var> or, if
2205 * <var>processName</var> is null, all known content providers.
2206 * <em>If there are no matching providers, null is returned.</em>
2207 */
2208 public abstract List<ProviderInfo> queryContentProviders(
2209 String processName, int uid, int flags);
2210
2211 /**
2212 * Retrieve all of the information we know about a particular
2213 * instrumentation class.
2214 *
2215 * <p>Throws {@link NameNotFoundException} if instrumentation with the
kmccormick30498b42013-03-27 17:39:17 -07002216 * given class name cannot be found on the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002217 *
2218 * @param className The full name (i.e.
2219 * com.google.apps.contacts.InstrumentList) of an
2220 * Instrumentation class.
2221 * @param flags Additional option flags. Currently should always be 0.
2222 *
2223 * @return InstrumentationInfo containing information about the
2224 * instrumentation.
2225 */
2226 public abstract InstrumentationInfo getInstrumentationInfo(
2227 ComponentName className, int flags) throws NameNotFoundException;
2228
2229 /**
2230 * Retrieve information about available instrumentation code. May be used
2231 * to retrieve either all instrumentation code, or only the code targeting
2232 * a particular package.
2233 *
2234 * @param targetPackage If null, all instrumentation is returned; only the
2235 * instrumentation targeting this package name is
2236 * returned.
2237 * @param flags Additional option flags. Currently should always be 0.
2238 *
Dianne Hackborn4d023d212010-10-01 13:41:04 -07002239 * @return A List&lt;InstrumentationInfo&gt; containing one entry for each
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002240 * matching available Instrumentation. Returns an empty list if
2241 * there is no instrumentation available for the given package.
2242 */
2243 public abstract List<InstrumentationInfo> queryInstrumentation(
2244 String targetPackage, int flags);
2245
2246 /**
2247 * Retrieve an image from a package. This is a low-level API used by
2248 * the various package manager info structures (such as
2249 * {@link ComponentInfo} to implement retrieval of their associated
2250 * icon.
2251 *
2252 * @param packageName The name of the package that this icon is coming from.
kmccormick30498b42013-03-27 17:39:17 -07002253 * Cannot be null.
2254 * @param resid The resource identifier of the desired image. Cannot be 0.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002255 * @param appInfo Overall information about <var>packageName</var>. This
2256 * may be null, in which case the application information will be retrieved
2257 * for you if needed; if you already have this information around, it can
2258 * be much more efficient to supply it here.
2259 *
2260 * @return Returns a Drawable holding the requested image. Returns null if
2261 * an image could not be found for any reason.
2262 */
2263 public abstract Drawable getDrawable(String packageName, int resid,
2264 ApplicationInfo appInfo);
2265
2266 /**
2267 * Retrieve the icon associated with an activity. Given the full name of
2268 * an activity, retrieves the information about it and calls
2269 * {@link ComponentInfo#loadIcon ComponentInfo.loadIcon()} to return its icon.
kmccormick30498b42013-03-27 17:39:17 -07002270 * If the activity cannot be found, NameNotFoundException is thrown.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002271 *
2272 * @param activityName Name of the activity whose icon is to be retrieved.
2273 *
2274 * @return Returns the image of the icon, or the default activity icon if
2275 * it could not be found. Does not return null.
2276 * @throws NameNotFoundException Thrown if the resources for the given
2277 * activity could not be loaded.
2278 *
2279 * @see #getActivityIcon(Intent)
2280 */
2281 public abstract Drawable getActivityIcon(ComponentName activityName)
2282 throws NameNotFoundException;
2283
2284 /**
2285 * Retrieve the icon associated with an Intent. If intent.getClassName() is
2286 * set, this simply returns the result of
2287 * getActivityIcon(intent.getClassName()). Otherwise it resolves the intent's
2288 * component and returns the icon associated with the resolved component.
kmccormick30498b42013-03-27 17:39:17 -07002289 * If intent.getClassName() cannot be found or the Intent cannot be resolved
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002290 * to a component, NameNotFoundException is thrown.
2291 *
2292 * @param intent The intent for which you would like to retrieve an icon.
2293 *
2294 * @return Returns the image of the icon, or the default activity icon if
2295 * it could not be found. Does not return null.
2296 * @throws NameNotFoundException Thrown if the resources for application
2297 * matching the given intent could not be loaded.
2298 *
2299 * @see #getActivityIcon(ComponentName)
2300 */
2301 public abstract Drawable getActivityIcon(Intent intent)
2302 throws NameNotFoundException;
2303
2304 /**
2305 * Return the generic icon for an activity that is used when no specific
2306 * icon is defined.
2307 *
2308 * @return Drawable Image of the icon.
2309 */
2310 public abstract Drawable getDefaultActivityIcon();
2311
2312 /**
2313 * Retrieve the icon associated with an application. If it has not defined
2314 * an icon, the default app icon is returned. Does not return null.
2315 *
2316 * @param info Information about application being queried.
2317 *
2318 * @return Returns the image of the icon, or the default application icon
2319 * if it could not be found.
2320 *
2321 * @see #getApplicationIcon(String)
2322 */
2323 public abstract Drawable getApplicationIcon(ApplicationInfo info);
2324
2325 /**
2326 * Retrieve the icon associated with an application. Given the name of the
2327 * application's package, retrieves the information about it and calls
kmccormick30498b42013-03-27 17:39:17 -07002328 * getApplicationIcon() to return its icon. If the application cannot be
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002329 * found, NameNotFoundException is thrown.
2330 *
2331 * @param packageName Name of the package whose application icon is to be
2332 * retrieved.
2333 *
2334 * @return Returns the image of the icon, or the default application icon
2335 * if it could not be found. Does not return null.
2336 * @throws NameNotFoundException Thrown if the resources for the given
2337 * application could not be loaded.
2338 *
2339 * @see #getApplicationIcon(ApplicationInfo)
2340 */
2341 public abstract Drawable getApplicationIcon(String packageName)
2342 throws NameNotFoundException;
2343
2344 /**
Adam Powell81cd2e92010-04-21 16:35:18 -07002345 * Retrieve the logo associated with an activity. Given the full name of
2346 * an activity, retrieves the information about it and calls
2347 * {@link ComponentInfo#loadLogo ComponentInfo.loadLogo()} to return its logo.
kmccormick30498b42013-03-27 17:39:17 -07002348 * If the activity cannot be found, NameNotFoundException is thrown.
Adam Powell81cd2e92010-04-21 16:35:18 -07002349 *
2350 * @param activityName Name of the activity whose logo is to be retrieved.
2351 *
2352 * @return Returns the image of the logo or null if the activity has no
2353 * logo specified.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002354 *
Adam Powell81cd2e92010-04-21 16:35:18 -07002355 * @throws NameNotFoundException Thrown if the resources for the given
2356 * activity could not be loaded.
2357 *
2358 * @see #getActivityLogo(Intent)
2359 */
2360 public abstract Drawable getActivityLogo(ComponentName activityName)
2361 throws NameNotFoundException;
2362
2363 /**
2364 * Retrieve the logo associated with an Intent. If intent.getClassName() is
2365 * set, this simply returns the result of
2366 * getActivityLogo(intent.getClassName()). Otherwise it resolves the intent's
2367 * component and returns the logo associated with the resolved component.
kmccormick30498b42013-03-27 17:39:17 -07002368 * If intent.getClassName() cannot be found or the Intent cannot be resolved
Adam Powell81cd2e92010-04-21 16:35:18 -07002369 * to a component, NameNotFoundException is thrown.
2370 *
2371 * @param intent The intent for which you would like to retrieve a logo.
2372 *
2373 * @return Returns the image of the logo, or null if the activity has no
2374 * logo specified.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002375 *
Adam Powell81cd2e92010-04-21 16:35:18 -07002376 * @throws NameNotFoundException Thrown if the resources for application
2377 * matching the given intent could not be loaded.
2378 *
2379 * @see #getActivityLogo(ComponentName)
2380 */
2381 public abstract Drawable getActivityLogo(Intent intent)
2382 throws NameNotFoundException;
2383
2384 /**
2385 * Retrieve the logo associated with an application. If it has not specified
2386 * a logo, this method returns null.
2387 *
2388 * @param info Information about application being queried.
2389 *
2390 * @return Returns the image of the logo, or null if no logo is specified
2391 * by the application.
2392 *
2393 * @see #getApplicationLogo(String)
2394 */
2395 public abstract Drawable getApplicationLogo(ApplicationInfo info);
2396
2397 /**
2398 * Retrieve the logo associated with an application. Given the name of the
2399 * application's package, retrieves the information about it and calls
kmccormick30498b42013-03-27 17:39:17 -07002400 * getApplicationLogo() to return its logo. If the application cannot be
Adam Powell81cd2e92010-04-21 16:35:18 -07002401 * found, NameNotFoundException is thrown.
2402 *
2403 * @param packageName Name of the package whose application logo is to be
2404 * retrieved.
2405 *
2406 * @return Returns the image of the logo, or null if no application logo
2407 * has been specified.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002408 *
Adam Powell81cd2e92010-04-21 16:35:18 -07002409 * @throws NameNotFoundException Thrown if the resources for the given
2410 * application could not be loaded.
2411 *
2412 * @see #getApplicationLogo(ApplicationInfo)
2413 */
2414 public abstract Drawable getApplicationLogo(String packageName)
2415 throws NameNotFoundException;
2416
2417 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002418 * Retrieve text from a package. This is a low-level API used by
2419 * the various package manager info structures (such as
2420 * {@link ComponentInfo} to implement retrieval of their associated
2421 * labels and other text.
2422 *
2423 * @param packageName The name of the package that this text is coming from.
kmccormick30498b42013-03-27 17:39:17 -07002424 * Cannot be null.
2425 * @param resid The resource identifier of the desired text. Cannot be 0.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002426 * @param appInfo Overall information about <var>packageName</var>. This
2427 * may be null, in which case the application information will be retrieved
2428 * for you if needed; if you already have this information around, it can
2429 * be much more efficient to supply it here.
2430 *
2431 * @return Returns a CharSequence holding the requested text. Returns null
2432 * if the text could not be found for any reason.
2433 */
2434 public abstract CharSequence getText(String packageName, int resid,
2435 ApplicationInfo appInfo);
2436
2437 /**
2438 * Retrieve an XML file from a package. This is a low-level API used to
2439 * retrieve XML meta data.
2440 *
2441 * @param packageName The name of the package that this xml is coming from.
kmccormick30498b42013-03-27 17:39:17 -07002442 * Cannot be null.
2443 * @param resid The resource identifier of the desired xml. Cannot be 0.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002444 * @param appInfo Overall information about <var>packageName</var>. This
2445 * may be null, in which case the application information will be retrieved
2446 * for you if needed; if you already have this information around, it can
2447 * be much more efficient to supply it here.
2448 *
2449 * @return Returns an XmlPullParser allowing you to parse out the XML
2450 * data. Returns null if the xml resource could not be found for any
2451 * reason.
2452 */
2453 public abstract XmlResourceParser getXml(String packageName, int resid,
2454 ApplicationInfo appInfo);
2455
2456 /**
2457 * Return the label to use for this application.
2458 *
2459 * @return Returns the label associated with this application, or null if
2460 * it could not be found for any reason.
kmccormick30498b42013-03-27 17:39:17 -07002461 * @param info The application to get the label of.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002462 */
2463 public abstract CharSequence getApplicationLabel(ApplicationInfo info);
2464
2465 /**
2466 * Retrieve the resources associated with an activity. Given the full
2467 * name of an activity, retrieves the information about it and calls
2468 * getResources() to return its application's resources. If the activity
kmccormick30498b42013-03-27 17:39:17 -07002469 * cannot be found, NameNotFoundException is thrown.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002470 *
2471 * @param activityName Name of the activity whose resources are to be
2472 * retrieved.
2473 *
2474 * @return Returns the application's Resources.
2475 * @throws NameNotFoundException Thrown if the resources for the given
2476 * application could not be loaded.
2477 *
2478 * @see #getResourcesForApplication(ApplicationInfo)
2479 */
2480 public abstract Resources getResourcesForActivity(ComponentName activityName)
2481 throws NameNotFoundException;
2482
2483 /**
2484 * Retrieve the resources for an application. Throws NameNotFoundException
2485 * if the package is no longer installed.
2486 *
2487 * @param app Information about the desired application.
2488 *
2489 * @return Returns the application's Resources.
2490 * @throws NameNotFoundException Thrown if the resources for the given
2491 * application could not be loaded (most likely because it was uninstalled).
2492 */
2493 public abstract Resources getResourcesForApplication(ApplicationInfo app)
2494 throws NameNotFoundException;
2495
2496 /**
2497 * Retrieve the resources associated with an application. Given the full
2498 * package name of an application, retrieves the information about it and
2499 * calls getResources() to return its application's resources. If the
kmccormick30498b42013-03-27 17:39:17 -07002500 * appPackageName cannot be found, NameNotFoundException is thrown.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002501 *
2502 * @param appPackageName Package name of the application whose resources
2503 * are to be retrieved.
2504 *
2505 * @return Returns the application's Resources.
2506 * @throws NameNotFoundException Thrown if the resources for the given
2507 * application could not be loaded.
2508 *
2509 * @see #getResourcesForApplication(ApplicationInfo)
2510 */
2511 public abstract Resources getResourcesForApplication(String appPackageName)
2512 throws NameNotFoundException;
2513
Amith Yamasani98edc952012-09-25 14:09:27 -07002514 /** @hide */
2515 public abstract Resources getResourcesForApplicationAsUser(String appPackageName, int userId)
2516 throws NameNotFoundException;
2517
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002518 /**
2519 * Retrieve overall information about an application package defined
2520 * in a package archive file
2521 *
2522 * @param archiveFilePath The path to the archive file
2523 * @param flags Additional option flags. Use any combination of
2524 * {@link #GET_ACTIVITIES},
2525 * {@link #GET_GIDS},
2526 * {@link #GET_CONFIGURATIONS},
2527 * {@link #GET_INSTRUMENTATION},
2528 * {@link #GET_PERMISSIONS},
2529 * {@link #GET_PROVIDERS},
2530 * {@link #GET_RECEIVERS},
2531 * {@link #GET_SERVICES},
2532 * {@link #GET_SIGNATURES}, to modify the data returned.
2533 *
2534 * @return Returns the information about the package. Returns
2535 * null if the package could not be successfully parsed.
2536 *
2537 * @see #GET_ACTIVITIES
2538 * @see #GET_GIDS
2539 * @see #GET_CONFIGURATIONS
2540 * @see #GET_INSTRUMENTATION
2541 * @see #GET_PERMISSIONS
2542 * @see #GET_PROVIDERS
2543 * @see #GET_RECEIVERS
2544 * @see #GET_SERVICES
2545 * @see #GET_SIGNATURES
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002546 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002547 */
2548 public PackageInfo getPackageArchiveInfo(String archiveFilePath, int flags) {
2549 PackageParser packageParser = new PackageParser(archiveFilePath);
2550 DisplayMetrics metrics = new DisplayMetrics();
2551 metrics.setToDefaults();
2552 final File sourceFile = new File(archiveFilePath);
2553 PackageParser.Package pkg = packageParser.parsePackage(
2554 sourceFile, archiveFilePath, metrics, 0);
2555 if (pkg == null) {
2556 return null;
2557 }
Kenny Root6ccd4122011-10-13 14:56:21 -07002558 if ((flags & GET_SIGNATURES) != 0) {
2559 packageParser.collectCertificates(pkg, 0);
2560 }
Dianne Hackborn7767eac2012-08-23 18:25:40 -07002561 PackageUserState state = new PackageUserState();
2562 return PackageParser.generatePackageInfo(pkg, null, flags, 0, 0, null, state);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002563 }
2564
2565 /**
Dianne Hackbornade3eca2009-05-11 18:54:45 -07002566 * @hide
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002567 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002568 * Install a package. Since this may take a little while, the result will
2569 * be posted back to the given observer. An installation will fail if the calling context
2570 * lacks the {@link android.Manifest.permission#INSTALL_PACKAGES} permission, if the
2571 * package named in the package file's manifest is already installed, or if there's no space
2572 * available on the device.
2573 *
2574 * @param packageURI The location of the package file to install. This can be a 'file:' or a
2575 * 'content:' URI.
2576 * @param observer An observer callback to get notified when the package installation is
2577 * complete. {@link IPackageInstallObserver#packageInstalled(String, int)} will be
2578 * called when that happens. observer may be null to indicate that no callback is desired.
Dianne Hackbornade3eca2009-05-11 18:54:45 -07002579 * @param flags - possible values: {@link #INSTALL_FORWARD_LOCK},
2580 * {@link #INSTALL_REPLACE_EXISTING}, {@link #INSTALL_ALLOW_TEST}.
Jacek Surazski65e13172009-04-28 15:26:38 +02002581 * @param installerPackageName Optional package name of the application that is performing the
2582 * installation. This identifies which market the package came from.
Jacek Surazski65e13172009-04-28 15:26:38 +02002583 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002584 public abstract void installPackage(
Jacek Surazski65e13172009-04-28 15:26:38 +02002585 Uri packageURI, IPackageInstallObserver observer, int flags,
2586 String installerPackageName);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002587
2588 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002589 * Similar to
2590 * {@link #installPackage(Uri, IPackageInstallObserver, int, String)} but
2591 * with an extra verification file provided.
2592 *
2593 * @param packageURI The location of the package file to install. This can
2594 * be a 'file:' or a 'content:' URI.
2595 * @param observer An observer callback to get notified when the package
2596 * installation is complete.
2597 * {@link IPackageInstallObserver#packageInstalled(String, int)}
2598 * will be called when that happens. observer may be null to
2599 * indicate that no callback is desired.
2600 * @param flags - possible values: {@link #INSTALL_FORWARD_LOCK},
2601 * {@link #INSTALL_REPLACE_EXISTING}, {@link #INSTALL_ALLOW_TEST}
2602 * .
2603 * @param installerPackageName Optional package name of the application that
2604 * is performing the installation. This identifies which market
2605 * the package came from.
2606 * @param verificationURI The location of the supplementary verification
Anonymous Cowardceb1b0b2012-04-24 10:35:16 -07002607 * file. This can be a 'file:' or a 'content:' URI. May be
2608 * {@code null}.
2609 * @param manifestDigest an object that holds the digest of the package
2610 * which can be used to verify ownership. May be {@code null}.
2611 * @param encryptionParams if the package to be installed is encrypted,
2612 * these parameters describing the encryption and authentication
2613 * used. May be {@code null}.
Kenny Root5ab21572011-07-27 11:11:19 -07002614 * @hide
2615 */
2616 public abstract void installPackageWithVerification(Uri packageURI,
2617 IPackageInstallObserver observer, int flags, String installerPackageName,
Anonymous Cowardceb1b0b2012-04-24 10:35:16 -07002618 Uri verificationURI, ManifestDigest manifestDigest,
Rich Canningse1d7c712012-08-08 12:46:06 -07002619 ContainerEncryptionParams encryptionParams);
Kenny Root5ab21572011-07-27 11:11:19 -07002620
2621 /**
rich cannings706e8ba2012-08-20 13:20:14 -07002622 * Similar to
2623 * {@link #installPackage(Uri, IPackageInstallObserver, int, String)} but
2624 * with an extra verification information provided.
2625 *
2626 * @param packageURI The location of the package file to install. This can
2627 * be a 'file:' or a 'content:' URI.
2628 * @param observer An observer callback to get notified when the package
2629 * installation is complete.
2630 * {@link IPackageInstallObserver#packageInstalled(String, int)}
2631 * will be called when that happens. observer may be null to
2632 * indicate that no callback is desired.
2633 * @param flags - possible values: {@link #INSTALL_FORWARD_LOCK},
2634 * {@link #INSTALL_REPLACE_EXISTING}, {@link #INSTALL_ALLOW_TEST}
2635 * .
2636 * @param installerPackageName Optional package name of the application that
2637 * is performing the installation. This identifies which market
2638 * the package came from.
2639 * @param verificationParams an object that holds signal information to
2640 * assist verification. May be {@code null}.
2641 * @param encryptionParams if the package to be installed is encrypted,
2642 * these parameters describing the encryption and authentication
2643 * used. May be {@code null}.
2644 *
2645 * @hide
2646 */
2647 public abstract void installPackageWithVerificationAndEncryption(Uri packageURI,
2648 IPackageInstallObserver observer, int flags, String installerPackageName,
2649 VerificationParams verificationParams,
2650 ContainerEncryptionParams encryptionParams);
2651
2652 /**
Dianne Hackborn7767eac2012-08-23 18:25:40 -07002653 * If there is already an application with the given package name installed
2654 * on the system for other users, also install it for the calling user.
2655 * @hide
2656 */
2657 public abstract int installExistingPackage(String packageName)
2658 throws NameNotFoundException;
2659
2660 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002661 * Allows a package listening to the
2662 * {@link Intent#ACTION_PACKAGE_NEEDS_VERIFICATION package verification
Kenny Root3a9b5fb2011-09-20 14:15:38 -07002663 * broadcast} to respond to the package manager. The response must include
2664 * the {@code verificationCode} which is one of
2665 * {@link PackageManager#VERIFICATION_ALLOW} or
2666 * {@link PackageManager#VERIFICATION_REJECT}.
Kenny Root5ab21572011-07-27 11:11:19 -07002667 *
2668 * @param id pending package identifier as passed via the
kmccormick30498b42013-03-27 17:39:17 -07002669 * {@link PackageManager#EXTRA_VERIFICATION_ID} Intent extra.
Kenny Root3a9b5fb2011-09-20 14:15:38 -07002670 * @param verificationCode either {@link PackageManager#VERIFICATION_ALLOW}
2671 * or {@link PackageManager#VERIFICATION_REJECT}.
rich cannings7e671512012-08-27 14:44:16 -07002672 * @throws SecurityException if the caller does not have the
Dianne Hackborn8832c182012-09-17 17:20:24 -07002673 * PACKAGE_VERIFICATION_AGENT permission.
Kenny Root5ab21572011-07-27 11:11:19 -07002674 */
Kenny Root3a9b5fb2011-09-20 14:15:38 -07002675 public abstract void verifyPendingInstall(int id, int verificationCode);
Kenny Root5ab21572011-07-27 11:11:19 -07002676
2677 /**
rich canningsd9ef3e52012-08-22 14:28:05 -07002678 * Allows a package listening to the
2679 * {@link Intent#ACTION_PACKAGE_NEEDS_VERIFICATION package verification
2680 * broadcast} to extend the default timeout for a response and declare what
2681 * action to perform after the timeout occurs. The response must include
2682 * the {@code verificationCodeAtTimeout} which is one of
2683 * {@link PackageManager#VERIFICATION_ALLOW} or
2684 * {@link PackageManager#VERIFICATION_REJECT}.
2685 *
2686 * This method may only be called once per package id. Additional calls
2687 * will have no effect.
2688 *
2689 * @param id pending package identifier as passed via the
kmccormick30498b42013-03-27 17:39:17 -07002690 * {@link PackageManager#EXTRA_VERIFICATION_ID} Intent extra.
rich canningsd9ef3e52012-08-22 14:28:05 -07002691 * @param verificationCodeAtTimeout either
2692 * {@link PackageManager#VERIFICATION_ALLOW} or
rich canningsd1b5cfc2012-08-29 14:49:51 -07002693 * {@link PackageManager#VERIFICATION_REJECT}. If
2694 * {@code verificationCodeAtTimeout} is neither
2695 * {@link PackageManager#VERIFICATION_ALLOW} or
2696 * {@link PackageManager#VERIFICATION_REJECT}, then
2697 * {@code verificationCodeAtTimeout} will default to
rich canningsd9ef3e52012-08-22 14:28:05 -07002698 * {@link PackageManager#VERIFICATION_REJECT}.
2699 * @param millisecondsToDelay the amount of time requested for the timeout.
2700 * Must be positive and less than
rich canningsd1b5cfc2012-08-29 14:49:51 -07002701 * {@link PackageManager#MAXIMUM_VERIFICATION_TIMEOUT}. If
2702 * {@code millisecondsToDelay} is out of bounds,
2703 * {@code millisecondsToDelay} will be set to the closest in
2704 * bounds value; namely, 0 or
rich canningsd9ef3e52012-08-22 14:28:05 -07002705 * {@link PackageManager#MAXIMUM_VERIFICATION_TIMEOUT}.
rich cannings7e671512012-08-27 14:44:16 -07002706 * @throws SecurityException if the caller does not have the
Dianne Hackborn8832c182012-09-17 17:20:24 -07002707 * PACKAGE_VERIFICATION_AGENT permission.
rich canningsd9ef3e52012-08-22 14:28:05 -07002708 */
2709 public abstract void extendVerificationTimeout(int id,
2710 int verificationCodeAtTimeout, long millisecondsToDelay);
2711
2712 /**
Dianne Hackborn880119b2010-11-18 22:26:40 -08002713 * Change the installer associated with a given package. There are limitations
2714 * on how the installer package can be changed; in particular:
2715 * <ul>
2716 * <li> A SecurityException will be thrown if <var>installerPackageName</var>
2717 * is not signed with the same certificate as the calling application.
2718 * <li> A SecurityException will be thrown if <var>targetPackage</var> already
2719 * has an installer package, and that installer package is not signed with
2720 * the same certificate as the calling application.
2721 * </ul>
2722 *
2723 * @param targetPackage The installed package whose installer will be changed.
2724 * @param installerPackageName The package name of the new installer. May be
2725 * null to clear the association.
2726 */
2727 public abstract void setInstallerPackageName(String targetPackage,
2728 String installerPackageName);
2729
2730 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002731 * Attempts to delete a package. Since this may take a little while, the result will
2732 * be posted back to the given observer. A deletion will fail if the calling context
2733 * lacks the {@link android.Manifest.permission#DELETE_PACKAGES} permission, if the
2734 * named package cannot be found, or if the named package is a "system package".
2735 * (TODO: include pointer to documentation on "system packages")
2736 *
2737 * @param packageName The name of the package to delete
2738 * @param observer An observer callback to get notified when the package deletion is
2739 * complete. {@link android.content.pm.IPackageDeleteObserver#packageDeleted(boolean)} will be
2740 * called when that happens. observer may be null to indicate that no callback is desired.
Dianne Hackborn7767eac2012-08-23 18:25:40 -07002741 * @param flags - possible values: {@link #DELETE_KEEP_DATA},
2742 * {@link #DELETE_ALL_USERS}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002743 *
2744 * @hide
2745 */
2746 public abstract void deletePackage(
2747 String packageName, IPackageDeleteObserver observer, int flags);
Jacek Surazski65e13172009-04-28 15:26:38 +02002748
2749 /**
2750 * Retrieve the package name of the application that installed a package. This identifies
2751 * which market the package came from.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002752 *
Jacek Surazski65e13172009-04-28 15:26:38 +02002753 * @param packageName The name of the package to query
2754 */
2755 public abstract String getInstallerPackageName(String packageName);
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002756
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002757 /**
2758 * Attempts to clear the user data directory of an application.
2759 * Since this may take a little while, the result will
2760 * be posted back to the given observer. A deletion will fail if the
2761 * named package cannot be found, or if the named package is a "system package".
2762 *
2763 * @param packageName The name of the package
2764 * @param observer An observer callback to get notified when the operation is finished
2765 * {@link android.content.pm.IPackageDataObserver#onRemoveCompleted(String, boolean)}
2766 * will be called when that happens. observer may be null to indicate that
2767 * no callback is desired.
2768 *
2769 * @hide
2770 */
2771 public abstract void clearApplicationUserData(String packageName,
2772 IPackageDataObserver observer);
2773 /**
2774 * Attempts to delete the cache files associated with an application.
2775 * Since this may take a little while, the result will
2776 * be posted back to the given observer. A deletion will fail if the calling context
2777 * lacks the {@link android.Manifest.permission#DELETE_CACHE_FILES} permission, if the
2778 * named package cannot be found, or if the named package is a "system package".
2779 *
2780 * @param packageName The name of the package to delete
2781 * @param observer An observer callback to get notified when the cache file deletion
2782 * is complete.
2783 * {@link android.content.pm.IPackageDataObserver#onRemoveCompleted(String, boolean)}
2784 * will be called when that happens. observer may be null to indicate that
2785 * no callback is desired.
2786 *
2787 * @hide
2788 */
2789 public abstract void deleteApplicationCacheFiles(String packageName,
2790 IPackageDataObserver observer);
2791
2792 /**
2793 * Free storage by deleting LRU sorted list of cache files across
2794 * all applications. If the currently available free storage
2795 * on the device is greater than or equal to the requested
2796 * free storage, no cache files are cleared. If the currently
2797 * available storage on the device is less than the requested
2798 * free storage, some or all of the cache files across
2799 * all applications are deleted (based on last accessed time)
2800 * to increase the free storage space on the device to
2801 * the requested value. There is no guarantee that clearing all
2802 * the cache files from all applications will clear up
2803 * enough storage to achieve the desired value.
2804 * @param freeStorageSize The number of bytes of storage to be
2805 * freed by the system. Say if freeStorageSize is XX,
2806 * and the current free storage is YY,
2807 * if XX is less than YY, just return. if not free XX-YY number
2808 * of bytes if possible.
2809 * @param observer call back used to notify when
2810 * the operation is completed
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002811 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002812 * @hide
2813 */
2814 public abstract void freeStorageAndNotify(long freeStorageSize, IPackageDataObserver observer);
Suchi Amalapurapu1ccac752009-06-12 10:09:58 -07002815
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002816 /**
2817 * Free storage by deleting LRU sorted list of cache files across
2818 * all applications. If the currently available free storage
2819 * on the device is greater than or equal to the requested
2820 * free storage, no cache files are cleared. If the currently
2821 * available storage on the device is less than the requested
2822 * free storage, some or all of the cache files across
2823 * all applications are deleted (based on last accessed time)
2824 * to increase the free storage space on the device to
2825 * the requested value. There is no guarantee that clearing all
2826 * the cache files from all applications will clear up
2827 * enough storage to achieve the desired value.
2828 * @param freeStorageSize The number of bytes of storage to be
2829 * freed by the system. Say if freeStorageSize is XX,
2830 * and the current free storage is YY,
2831 * if XX is less than YY, just return. if not free XX-YY number
2832 * of bytes if possible.
Suchi Amalapurapu1ccac752009-06-12 10:09:58 -07002833 * @param pi IntentSender call back used to
2834 * notify when the operation is completed.May be null
2835 * to indicate that no call back is desired.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002836 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002837 * @hide
2838 */
Suchi Amalapurapubc806f62009-06-17 15:18:19 -07002839 public abstract void freeStorage(long freeStorageSize, IntentSender pi);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002840
2841 /**
2842 * Retrieve the size information for a package.
2843 * Since this may take a little while, the result will
2844 * be posted back to the given observer. The calling context
2845 * should have the {@link android.Manifest.permission#GET_PACKAGE_SIZE} permission.
2846 *
2847 * @param packageName The name of the package whose size information is to be retrieved
Dianne Hackborn0c380492012-08-20 17:23:30 -07002848 * @param userHandle The user whose size information should be retrieved.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002849 * @param observer An observer callback to get notified when the operation
2850 * is complete.
2851 * {@link android.content.pm.IPackageStatsObserver#onGetStatsCompleted(PackageStats, boolean)}
2852 * The observer's callback is invoked with a PackageStats object(containing the
2853 * code, data and cache sizes of the package) and a boolean value representing
2854 * the status of the operation. observer may be null to indicate that
2855 * no callback is desired.
2856 *
2857 * @hide
2858 */
Dianne Hackborn0c380492012-08-20 17:23:30 -07002859 public abstract void getPackageSizeInfo(String packageName, int userHandle,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002860 IPackageStatsObserver observer);
2861
2862 /**
Dianne Hackborn0c380492012-08-20 17:23:30 -07002863 * Like {@link #getPackageSizeInfo(String, int, IPackageStatsObserver)}, but
2864 * returns the size for the calling user.
2865 *
2866 * @hide
2867 */
2868 public void getPackageSizeInfo(String packageName, IPackageStatsObserver observer) {
2869 getPackageSizeInfo(packageName, UserHandle.myUserId(), observer);
2870 }
2871
2872 /**
Dianne Hackborna7ca0e52009-12-01 14:31:55 -08002873 * @deprecated This function no longer does anything; it was an old
kmccormickac66b852013-03-28 15:17:15 -07002874 * approach to managing preferred activities, which has been superseded
2875 * by (and conflicts with) the modern activity-based preferences.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002876 */
Dianne Hackborna7ca0e52009-12-01 14:31:55 -08002877 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002878 public abstract void addPackageToPreferred(String packageName);
2879
2880 /**
Dianne Hackborna7ca0e52009-12-01 14:31:55 -08002881 * @deprecated This function no longer does anything; it was an old
kmccormickac66b852013-03-28 15:17:15 -07002882 * approach to managing preferred activities, which has been superseded
2883 * by (and conflicts with) the modern activity-based preferences.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002884 */
Dianne Hackborna7ca0e52009-12-01 14:31:55 -08002885 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002886 public abstract void removePackageFromPreferred(String packageName);
2887
2888 /**
2889 * Retrieve the list of all currently configured preferred packages. The
2890 * first package on the list is the most preferred, the last is the
2891 * least preferred.
2892 *
2893 * @param flags Additional option flags. Use any combination of
2894 * {@link #GET_ACTIVITIES},
2895 * {@link #GET_GIDS},
2896 * {@link #GET_CONFIGURATIONS},
2897 * {@link #GET_INSTRUMENTATION},
2898 * {@link #GET_PERMISSIONS},
2899 * {@link #GET_PROVIDERS},
2900 * {@link #GET_RECEIVERS},
2901 * {@link #GET_SERVICES},
2902 * {@link #GET_SIGNATURES}, to modify the data returned.
2903 *
2904 * @return Returns a list of PackageInfo objects describing each
2905 * preferred application, in order of preference.
2906 *
2907 * @see #GET_ACTIVITIES
2908 * @see #GET_GIDS
2909 * @see #GET_CONFIGURATIONS
2910 * @see #GET_INSTRUMENTATION
2911 * @see #GET_PERMISSIONS
2912 * @see #GET_PROVIDERS
2913 * @see #GET_RECEIVERS
2914 * @see #GET_SERVICES
2915 * @see #GET_SIGNATURES
2916 */
2917 public abstract List<PackageInfo> getPreferredPackages(int flags);
2918
2919 /**
Dianne Hackborn2ee89ea2010-03-10 18:27:09 -08002920 * @deprecated This is a protected API that should not have been available
2921 * to third party applications. It is the platform's responsibility for
kmccormick30498b42013-03-27 17:39:17 -07002922 * assigning preferred activities and this cannot be directly modified.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002923 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002924 * Add a new preferred activity mapping to the system. This will be used
2925 * to automatically select the given activity component when
2926 * {@link Context#startActivity(Intent) Context.startActivity()} finds
2927 * multiple matching activities and also matches the given filter.
2928 *
2929 * @param filter The set of intents under which this activity will be
2930 * made preferred.
2931 * @param match The IntentFilter match category that this preference
2932 * applies to.
2933 * @param set The set of activities that the user was picking from when
2934 * this preference was made.
2935 * @param activity The component name of the activity that is to be
2936 * preferred.
2937 */
Dianne Hackborn2ee89ea2010-03-10 18:27:09 -08002938 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002939 public abstract void addPreferredActivity(IntentFilter filter, int match,
2940 ComponentName[] set, ComponentName activity);
2941
2942 /**
Amith Yamasania3f133a2012-08-09 17:11:28 -07002943 * Same as {@link #addPreferredActivity(IntentFilter, int,
2944 ComponentName[], ComponentName)}, but with a specific userId to apply the preference
2945 to.
2946 * @hide
2947 */
2948 public void addPreferredActivity(IntentFilter filter, int match,
2949 ComponentName[] set, ComponentName activity, int userId) {
2950 throw new RuntimeException("Not implemented. Must override in a subclass.");
2951 }
2952
2953 /**
Dianne Hackborn2ee89ea2010-03-10 18:27:09 -08002954 * @deprecated This is a protected API that should not have been available
2955 * to third party applications. It is the platform's responsibility for
kmccormick30498b42013-03-27 17:39:17 -07002956 * assigning preferred activities and this cannot be directly modified.
Amith Yamasani4b2e9342011-03-31 12:38:53 -07002957 *
Satish Sampath8dbe6122009-06-02 23:35:54 +01002958 * Replaces an existing preferred activity mapping to the system, and if that were not present
2959 * adds a new preferred activity. This will be used
2960 * to automatically select the given activity component when
2961 * {@link Context#startActivity(Intent) Context.startActivity()} finds
2962 * multiple matching activities and also matches the given filter.
2963 *
2964 * @param filter The set of intents under which this activity will be
2965 * made preferred.
2966 * @param match The IntentFilter match category that this preference
2967 * applies to.
2968 * @param set The set of activities that the user was picking from when
2969 * this preference was made.
2970 * @param activity The component name of the activity that is to be
2971 * preferred.
2972 * @hide
2973 */
Dianne Hackborn2ee89ea2010-03-10 18:27:09 -08002974 @Deprecated
Satish Sampath8dbe6122009-06-02 23:35:54 +01002975 public abstract void replacePreferredActivity(IntentFilter filter, int match,
2976 ComponentName[] set, ComponentName activity);
2977
2978 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002979 * Remove all preferred activity mappings, previously added with
2980 * {@link #addPreferredActivity}, from the
2981 * system whose activities are implemented in the given package name.
Dianne Hackborn2ee89ea2010-03-10 18:27:09 -08002982 * An application can only clear its own package(s).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002983 *
2984 * @param packageName The name of the package whose preferred activity
2985 * mappings are to be removed.
2986 */
2987 public abstract void clearPackagePreferredActivities(String packageName);
2988
2989 /**
2990 * Retrieve all preferred activities, previously added with
2991 * {@link #addPreferredActivity}, that are
2992 * currently registered with the system.
2993 *
2994 * @param outFilters A list in which to place the filters of all of the
2995 * preferred activities, or null for none.
2996 * @param outActivities A list in which to place the component names of
2997 * all of the preferred activities, or null for none.
2998 * @param packageName An option package in which you would like to limit
2999 * the list. If null, all activities will be returned; if non-null, only
3000 * those activities in the given package are returned.
3001 *
3002 * @return Returns the total number of registered preferred activities
3003 * (the number of distinct IntentFilter records, not the number of unique
3004 * activity components) that were found.
3005 */
3006 public abstract int getPreferredActivities(List<IntentFilter> outFilters,
3007 List<ComponentName> outActivities, String packageName);
3008
3009 /**
3010 * Set the enabled setting for a package component (activity, receiver, service, provider).
3011 * This setting will override any enabled state which may have been set by the component in its
3012 * manifest.
3013 *
3014 * @param componentName The component to enable
3015 * @param newState The new enabled state for the component. The legal values for this state
3016 * are:
3017 * {@link #COMPONENT_ENABLED_STATE_ENABLED},
3018 * {@link #COMPONENT_ENABLED_STATE_DISABLED}
3019 * and
3020 * {@link #COMPONENT_ENABLED_STATE_DEFAULT}
3021 * The last one removes the setting, thereby restoring the component's state to
3022 * whatever was set in it's manifest (or enabled, by default).
3023 * @param flags Optional behavior flags: {@link #DONT_KILL_APP} or 0.
3024 */
3025 public abstract void setComponentEnabledSetting(ComponentName componentName,
3026 int newState, int flags);
3027
3028
3029 /**
3030 * Return the the enabled setting for a package component (activity,
3031 * receiver, service, provider). This returns the last value set by
3032 * {@link #setComponentEnabledSetting(ComponentName, int, int)}; in most
3033 * cases this value will be {@link #COMPONENT_ENABLED_STATE_DEFAULT} since
3034 * the value originally specified in the manifest has not been modified.
3035 *
3036 * @param componentName The component to retrieve.
3037 * @return Returns the current enabled state for the component. May
3038 * be one of {@link #COMPONENT_ENABLED_STATE_ENABLED},
3039 * {@link #COMPONENT_ENABLED_STATE_DISABLED}, or
3040 * {@link #COMPONENT_ENABLED_STATE_DEFAULT}. The last one means the
3041 * component's enabled state is based on the original information in
3042 * the manifest as found in {@link ComponentInfo}.
3043 */
3044 public abstract int getComponentEnabledSetting(ComponentName componentName);
3045
3046 /**
3047 * Set the enabled setting for an application
3048 * This setting will override any enabled state which may have been set by the application in
3049 * its manifest. It also overrides the enabled state set in the manifest for any of the
3050 * application's components. It does not override any enabled state set by
3051 * {@link #setComponentEnabledSetting} for any of the application's components.
3052 *
3053 * @param packageName The package name of the application to enable
3054 * @param newState The new enabled state for the component. The legal values for this state
3055 * are:
3056 * {@link #COMPONENT_ENABLED_STATE_ENABLED},
3057 * {@link #COMPONENT_ENABLED_STATE_DISABLED}
3058 * and
3059 * {@link #COMPONENT_ENABLED_STATE_DEFAULT}
3060 * The last one removes the setting, thereby restoring the applications's state to
3061 * whatever was set in its manifest (or enabled, by default).
3062 * @param flags Optional behavior flags: {@link #DONT_KILL_APP} or 0.
3063 */
3064 public abstract void setApplicationEnabledSetting(String packageName,
3065 int newState, int flags);
Amith Yamasani4b2e9342011-03-31 12:38:53 -07003066
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003067 /**
3068 * Return the the enabled setting for an application. This returns
3069 * the last value set by
3070 * {@link #setApplicationEnabledSetting(String, int, int)}; in most
3071 * cases this value will be {@link #COMPONENT_ENABLED_STATE_DEFAULT} since
3072 * the value originally specified in the manifest has not been modified.
3073 *
3074 * @param packageName The component to retrieve.
3075 * @return Returns the current enabled state for the component. May
3076 * be one of {@link #COMPONENT_ENABLED_STATE_ENABLED},
3077 * {@link #COMPONENT_ENABLED_STATE_DISABLED}, or
3078 * {@link #COMPONENT_ENABLED_STATE_DEFAULT}. The last one means the
3079 * application's enabled state is based on the original information in
3080 * the manifest as found in {@link ComponentInfo}.
Mathew Inwood1b9f8d92011-09-26 13:23:56 +01003081 * @throws IllegalArgumentException if the named package does not exist.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003082 */
3083 public abstract int getApplicationEnabledSetting(String packageName);
3084
3085 /**
Amith Yamasani655d0e22013-06-12 14:19:10 -07003086 * Puts the package in a blocked state, which is almost like an uninstalled state,
3087 * making the package unavailable, but it doesn't remove the data or the actual
3088 * package file.
3089 * @hide
3090 */
3091 public abstract boolean setApplicationBlockedSettingAsUser(String packageName, boolean blocked,
3092 UserHandle userHandle);
3093
3094 /**
3095 * Returns the blocked state of a package.
3096 * @see #setApplicationBlockedSettingAsUser(String, boolean, UserHandle)
3097 * @hide
3098 */
3099 public abstract boolean getApplicationBlockedSettingAsUser(String packageName,
3100 UserHandle userHandle);
3101
3102 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003103 * Return whether the device has been booted into safe mode.
3104 */
3105 public abstract boolean isSafeMode();
Suchi Amalapurapu8946dd32010-02-19 09:19:34 -08003106
3107 /**
3108 * Attempts to move package resources from internal to external media or vice versa.
3109 * Since this may take a little while, the result will
3110 * be posted back to the given observer. This call may fail if the calling context
3111 * lacks the {@link android.Manifest.permission#MOVE_PACKAGE} permission, if the
3112 * named package cannot be found, or if the named package is a "system package".
3113 *
3114 * @param packageName The name of the package to delete
3115 * @param observer An observer callback to get notified when the package move is
3116 * complete. {@link android.content.pm.IPackageMoveObserver#packageMoved(boolean)} will be
3117 * called when that happens. observer may be null to indicate that no callback is desired.
3118 * @param flags To indicate install location {@link #MOVE_INTERNAL} or
3119 * {@link #MOVE_EXTERNAL_MEDIA}
3120 *
3121 * @hide
3122 */
3123 public abstract void movePackage(
3124 String packageName, IPackageMoveObserver observer, int flags);
Amith Yamasani4b2e9342011-03-31 12:38:53 -07003125
3126 /**
Amith Yamasani13593602012-03-22 16:16:17 -07003127 * Returns the device identity that verifiers can use to associate their scheme to a particular
3128 * device. This should not be used by anything other than a package verifier.
3129 *
Kenny Root0aaa0d92011-09-12 16:42:55 -07003130 * @return identity that uniquely identifies current device
3131 * @hide
3132 */
3133 public abstract VerifierDeviceIdentity getVerifierDeviceIdentity();
Amith Yamasani742a6712011-05-04 14:49:28 -07003134
3135 /**
3136 * Returns the data directory for a particular user and package, given the uid of the package.
3137 * @param uid uid of the package, including the userId and appId
3138 * @param packageName name of the package
3139 * @return the user-specific data directory for the package
3140 * @hide
3141 */
3142 public static String getDataDirForUser(int userId, String packageName) {
3143 // TODO: This should be shared with Installer's knowledge of user directory
3144 return Environment.getDataDirectory().toString() + "/user/" + userId
3145 + "/" + packageName;
3146 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003147}