StorageVolume

EXTRA_STORAGE_VOLUME

static val EXTRA_STORAGE_VOLUME: String

Name of the Parcelable extra in the Intent.ACTION_MEDIA_REMOVED, Intent.ACTION_MEDIA_UNMOUNTED, Intent.ACTION_MEDIA_CHECKING, Intent.ACTION_MEDIA_NOFS, Intent.ACTION_MEDIA_MOUNTED, Intent.ACTION_MEDIA_SHARED, Intent.ACTION_MEDIA_BAD_REMOVAL, Intent.ACTION_MEDIA_UNMOUNTABLE, and Intent.ACTION_MEDIA_EJECT broadcast that contains a StorageVolume.

Value: "android.os.storage.extra.STORAGE_VOLUME"

createAccessIntent

fun createAccessIntent(directoryName: String!): Intent?

Deprecated: Callers should migrate to using Intent.ACTION_OPEN_DOCUMENT_TREE instead. Launching this Intent on devices running android.os.Build.VERSION_CODES#Q or higher, will immediately finish with a result code of android.app.Activity#RESULT_CANCELED.

Builds an intent to give access to a standard storage directory or entire volume after obtaining the user's approval.

When invoked, the system will ask the user to grant access to the requested directory (and its descendants). The result of the request will be returned to the activity through the onActivityResult method.

To gain access to descendants (child, grandchild, etc) documents, use DocumentsContract.buildDocumentUriUsingTree(Uri, String), or DocumentsContract.buildChildDocumentsUriUsingTree(Uri, String) with the returned URI.

If your application only needs to store internal data, consider using Context.getExternalFilesDirs, Context.getExternalCacheDirs(), or Context.getExternalMediaDirs(), which require no permissions to read or write.

Access to the entire volume is only available for non-primary volumes (for the primary volume, apps can use the android.Manifest.permission#READ_EXTERNAL_STORAGE and android.Manifest.permission#WRITE_EXTERNAL_STORAGE permissions) and should be used with caution, since users are more likely to deny access when asked for entire volume access rather than specific directories.

createOpenDocumentTreeIntent

fun createOpenDocumentTreeIntent(): Intent

Builds an Intent.ACTION_OPEN_DOCUMENT_TREE to allow the user to grant access to any directory subtree (or entire volume) from the android.provider.DocumentsProviders available on the device. The initial location of the document navigation will be the root of this StorageVolume. Note that the returned Intent simply suggests that the user picks this StorageVolume by default, but the user may select a different location. Callers must respect the user's chosen location, even if it is different from the originally requested location.

describeContents

fun describeContents(): Int

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getDescription

fun getDescription(context: Context!): String!

Returns a user-visible description of the volume.

getDirectory

fun getDirectory(): File?

Returns the directory where this volume is currently mounted.

Direct filesystem access via this path has significant emulation overhead, and apps are instead strongly encouraged to interact with media on storage volumes via the MediaStore APIs.

This directory does not give apps any additional access beyond what they already have via MediaStore.

getMediaStoreVolumeName

fun getMediaStoreVolumeName(): String?

Return the volume name that can be used to interact with this storage device through MediaStore.

getOwner

fun getOwner(): UserHandle

Returns the user that owns this volume

getState

fun getState(): String!

Returns the current state of the volume.

getStorageUuid

fun getStorageUuid(): UUID?

Gets the converted volume UUID. If a valid UUID is returned, it is compatible with other APIs that make use of UUID like android.os.storage.StorageManager#allocateBytes and android.content.pm.ApplicationInfo#storageUuid

getUuid

fun getUuid(): String?

Gets the volume UUID, if any.

hashCode

fun hashCode(): Int

isEmulated

fun isEmulated(): Boolean

Returns true if the volume is emulated.

isPrimary

fun isPrimary(): Boolean

Returns true if the volume is the primary shared/external storage, which is the volume backed by Environment.getExternalStorageDirectory().

isRemovable

fun isRemovable(): Boolean

Returns true if the volume is removable.

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<StorageVolume!>