# StorageStatsManager Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # StorageStatsManager *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/android/app/usage/StorageStatsManager "View this page in Java") ``` open class StorageStatsManager ``` |---|--------------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.app.usage.StorageStatsManager](https://developer.android.com/reference/kotlin/android/app/usage/StorageStatsManager#) | Access to detailed storage statistics. This provides a summary of how apps, users, and external/shared storage is utilizing disk space. Note: no permissions are required when calling these APIs for your own package or UID. However, requesting details for any other package requires the`android.Manifest.permission#PACKAGE_USAGE_STATS`permission, which is a system-level permission that will not be granted to normal apps. Declaring that permission expresses your intention to use this API and an end user can then choose to grant this permission through the Settings application. ## Summary | Public methods || |-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | open[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [getFreeBytes](https://developer.android.com/reference/kotlin/android/app/usage/StorageStatsManager#getFreeBytes(java.util.UUID))`(`storageUuid:` `[UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#)`)` Return the free space on the requested storage volume. | | open[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [getTotalBytes](https://developer.android.com/reference/kotlin/android/app/usage/StorageStatsManager#getTotalBytes(java.util.UUID))`(`storageUuid:` `[UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#)`)` Return the total size of the underlying physical media that is hosting this storage volume. | | open[ExternalStorageStats](https://developer.android.com/reference/kotlin/android/app/usage/ExternalStorageStats) | [queryExternalStatsForUser](https://developer.android.com/reference/kotlin/android/app/usage/StorageStatsManager#queryExternalStatsForUser(java.util.UUID,%20android.os.UserHandle))`(`storageUuid:` `[UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#)`, `user:` `[UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#)`)` Return shared/external storage statistics for a specific[UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#)on the requested storage volume. | | open[StorageStats](https://developer.android.com/reference/kotlin/android/app/usage/StorageStats) | [queryStatsForPackage](https://developer.android.com/reference/kotlin/android/app/usage/StorageStatsManager#queryStatsForPackage(java.util.UUID,%20kotlin.String,%20android.os.UserHandle))`(`storageUuid:` `[UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#)`, `packageName:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `user:` `[UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#)`)` Return storage statistics for a specific package on the requested storage volume. | | open[StorageStats](https://developer.android.com/reference/kotlin/android/app/usage/StorageStats) | [queryStatsForUid](https://developer.android.com/reference/kotlin/android/app/usage/StorageStatsManager#queryStatsForUid(java.util.UUID,%20kotlin.Int))`(`storageUuid:` `[UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#)`, `uid:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Return storage statistics for a specific UID on the requested storage volume. | | open[StorageStats](https://developer.android.com/reference/kotlin/android/app/usage/StorageStats) | [queryStatsForUser](https://developer.android.com/reference/kotlin/android/app/usage/StorageStatsManager#queryStatsForUser(java.util.UUID,%20android.os.UserHandle))`(`storageUuid:` `[UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#)`, `user:` `[UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#)`)` Return storage statistics for a specific[UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#)on the requested storage volume. | ## Public methods ### getFreeBytes Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getFreeBytes(storageUuid: UUID): Long ``` Return the free space on the requested storage volume. This value is best suited for visual display to end users, since it's designed to reflect both unused space*and*and cached space that could be reclaimed by the system. Apps making logical decisions about disk space should always use[StorageManager.getAllocatableBytes(UUID)](https://developer.android.com/reference/kotlin/android/os/storage/StorageManager.html#getAllocatableBytes(java.util.UUID))instead of this value. This method may take several seconds to complete, so it should only be called from a worker thread. Value is a non-negative number of bytes. | Parameters || |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `storageUuid` | [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#):the UUID of the storage volume you're interested in, such as[StorageManager.UUID_DEFAULT](https://developer.android.com/reference/kotlin/android/os/storage/StorageManager.html#UUID_DEFAULT:java.util.UUID). This value cannot be`null`. | | Return || |------------------------------------------------------------------------------|------------------------------------------| | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | Value is a non-negative number of bytes. | | Exceptions || |-----------------------|----------------------------------------| | `java.io.IOException` | when the storage device isn't present. | ### getTotalBytes Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getTotalBytes(storageUuid: UUID): Long ``` Return the total size of the underlying physical media that is hosting this storage volume. This value is best suited for visual display to end users, since it's designed to reflect the total storage size advertised in a retail environment. Apps making logical decisions about disk space should always use[File.getTotalSpace()](https://developer.android.com/reference/kotlin/java/io/File.html#getTotalSpace())instead of this value. This method may take several seconds to complete, so it should only be called from a worker thread. Value is a non-negative number of bytes. | Parameters || |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `storageUuid` | [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#):the UUID of the storage volume you're interested in, such as[StorageManager.UUID_DEFAULT](https://developer.android.com/reference/kotlin/android/os/storage/StorageManager.html#UUID_DEFAULT:java.util.UUID). This value cannot be`null`. | | Return || |------------------------------------------------------------------------------|------------------------------------------| | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | Value is a non-negative number of bytes. | | Exceptions || |-----------------------|----------------------------------------| | `java.io.IOException` | when the storage device isn't present. | ### queryExternalStatsForUser Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun queryExternalStatsForUser(     storageUuid: UUID,     user: UserHandle ): ExternalStorageStats ``` Return shared/external storage statistics for a specific[UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#)on the requested storage volume. Note: this API requires the`android.Manifest.permission#PACKAGE_USAGE_STATS`permission, which is a system-level permission that will not be granted to normal apps. Declaring that permission expresses your intention to use this API and an end user can then choose to grant this permission through the Settings application. This method may take several seconds to complete, so it should only be called from a worker thread. | Parameters || |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `storageUuid` | [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#):the UUID of the storage volume you're interested in, such as[StorageManager.UUID_DEFAULT](https://developer.android.com/reference/kotlin/android/os/storage/StorageManager.html#UUID_DEFAULT:java.util.UUID). This value cannot be`null`. | | `user` | [UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#):This value cannot be`null`. | | Return || |---------------------------------------------------------------------------------------------------------------|-----------------------------| | [ExternalStorageStats](https://developer.android.com/reference/kotlin/android/app/usage/ExternalStorageStats) | This value cannot be`null`. | | Exceptions || |-----------------------|----------------------------------------| | `java.io.IOException` | when the storage device isn't present. | **See Also** - [android.os.Process#myUserHandle()](https://developer.android.com/reference/kotlin/android/os/Process.html#myUserHandle()) ### queryStatsForPackage Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun queryStatsForPackage(     storageUuid: UUID,     packageName: String,     user: UserHandle ): StorageStats ``` Return storage statistics for a specific package on the requested storage volume. Note: no permissions are required when calling this API for your own package. However, requesting details for any other package requires the`android.Manifest.permission#PACKAGE_USAGE_STATS`permission, which is a system-level permission that will not be granted to normal apps. Declaring that permission expresses your intention to use this API and an end user can then choose to grant this permission through the Settings application. Note: if the requested package uses the`android:sharedUserId`manifest feature, this call will be forced into a slower manual calculation path. If possible, consider always using[queryStatsForUid(java.util.UUID,int)](https://developer.android.com/reference/kotlin/android/app/usage/StorageStatsManager#queryStatsForUid(java.util.UUID,%20kotlin.Int)), which is typically faster. This method may take several seconds to complete, so it should only be called from a worker thread. | Parameters || |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `storageUuid` | [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#):the UUID of the storage volume you're interested in, such as[StorageManager.UUID_DEFAULT](https://developer.android.com/reference/kotlin/android/os/storage/StorageManager.html#UUID_DEFAULT:java.util.UUID). This value cannot be`null`. | | `packageName` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html):the package name you're interested in. This value cannot be`null`. | | `user` | [UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#):the user you're interested in. This value cannot be`null`. | | Return || |-----------------------------------------------------------------------------------------------|-----------------------------| | [StorageStats](https://developer.android.com/reference/kotlin/android/app/usage/StorageStats) | This value cannot be`null`. | | Exceptions || |-----------------------------------------------------------|-------------------------------------------------------------------------| | `android.content.pm.PackageManager.NameNotFoundException` | when the requested package name isn't installed for the requested user. | | `java.io.IOException` | when the storage device isn't present. | **See Also** - [android.content.pm.ApplicationInfo#storageUuid](https://developer.android.com/reference/kotlin/android/content/pm/ApplicationInfo.html#storageUuid:java.util.UUID) - [android.content.pm.PackageInfo#packageName](https://developer.android.com/reference/kotlin/android/content/pm/PackageInfo.html#packageName:kotlin.String) ### queryStatsForUid Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun queryStatsForUid(     storageUuid: UUID,     uid: Int ): StorageStats ``` Return storage statistics for a specific UID on the requested storage volume. Note: no permissions are required when calling this API for your own UID. However, requesting details for any other UID requires the`android.Manifest.permission#PACKAGE_USAGE_STATS`permission, which is a system-level permission that will not be granted to normal apps. Declaring that permission expresses your intention to use this API and an end user can then choose to grant this permission through the Settings application. This method may take several seconds to complete, so it should only be called from a worker thread. | Parameters || |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `storageUuid` | [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#):the UUID of the storage volume you're interested in, such as[StorageManager.UUID_DEFAULT](https://developer.android.com/reference/kotlin/android/os/storage/StorageManager.html#UUID_DEFAULT:java.util.UUID). This value cannot be`null`. | | `uid` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the UID you're interested in. | | Return || |-----------------------------------------------------------------------------------------------|-----------------------------| | [StorageStats](https://developer.android.com/reference/kotlin/android/app/usage/StorageStats) | This value cannot be`null`. | | Exceptions || |-----------------------|----------------------------------------| | `java.io.IOException` | when the storage device isn't present. | **See Also** - [android.content.pm.ApplicationInfo#storageUuid](https://developer.android.com/reference/kotlin/android/content/pm/ApplicationInfo.html#storageUuid:java.util.UUID) - [android.content.pm.ApplicationInfo#uid](https://developer.android.com/reference/kotlin/android/content/pm/ApplicationInfo.html#uid:kotlin.Int) ### queryStatsForUser Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun queryStatsForUser(     storageUuid: UUID,     user: UserHandle ): StorageStats ``` Return storage statistics for a specific[UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#)on the requested storage volume. Note: this API requires the`android.Manifest.permission#PACKAGE_USAGE_STATS`permission, which is a system-level permission that will not be granted to normal apps. Declaring that permission expresses your intention to use this API and an end user can then choose to grant this permission through the Settings application. This method may take several seconds to complete, so it should only be called from a worker thread. | Parameters || |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `storageUuid` | [UUID](https://developer.android.com/reference/kotlin/java/util/UUID.html#):the UUID of the storage volume you're interested in, such as[StorageManager.UUID_DEFAULT](https://developer.android.com/reference/kotlin/android/os/storage/StorageManager.html#UUID_DEFAULT:java.util.UUID). This value cannot be`null`. | | `user` | [UserHandle](https://developer.android.com/reference/kotlin/android/os/UserHandle.html#):the user you're interested in. This value cannot be`null`. | | Return || |-----------------------------------------------------------------------------------------------|-----------------------------| | [StorageStats](https://developer.android.com/reference/kotlin/android/app/usage/StorageStats) | This value cannot be`null`. | | Exceptions || |-----------------------|----------------------------------------| | `java.io.IOException` | when the storage device isn't present. | **See Also** - [android.os.Process#myUserHandle()](https://developer.android.com/reference/kotlin/android/os/Process.html#myUserHandle())