Added in API level 37

FileOperationResult

---

Kotlin |Java

class FileOperationResult : Parcelable

kotlin.Any
↳	android.os.storage.operations.FileOperationResult

Represents the result of a file operation.

Summary

Constants
static Int	ERROR_BUSY The system is too busy to handle the request.
static Int	ERROR_DISK_FULL The operation failed because the disk is full.
static Int	ERROR_INVALID_REQUEST The system cannot fulfill the request as configured.
static Int	ERROR_NONE Successful operation.
static Int	ERROR_PERMISSION_DENIED The operation failed due to missing permissions.
static Int	ERROR_UNKNOWN An unknown error.
static Int	ERROR_UNSUPPORTED_SOURCE The source of the operation is unsupported or invalid.
static Int	ERROR_UNSUPPORTED_TARGET The target of the operation is unsupported or invalid.
static Int	STATUS_FAILED The operation failed.
static Int	STATUS_FINISHED The operation finished successfully.
static Int	STATUS_IN_PROGRESS The operation is currently running.
static Int	STATUS_QUEUED The operation is queued and waiting to start.
static Int	STATUS_UNKNOWN Unknown status.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Int	getErrorCode() Returns the error code if the operation failed.
String?	getErrorMessage() Returns the error message if the operation failed.
MutableList<String!>	getFailedPaths() Returns the list of failures.
String	getRequestId() Returns the unique ID of the request.
OperationSource	getSource() Returns the OperationSource that was configured in the original FileOperationRequest.
Int	getStatus() Returns the current status of the operation.
OperationTarget?	getTarget() Returns the target of the file operation.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<FileOperationResult!>	CREATOR

Constants

ERROR_BUSY

Added in API level 37

static val ERROR_BUSY: Int

The system is too busy to handle the request.

This error is transient. Applications should consider retrying the operation after a short delay, potentially using an exponential backoff strategy.

Value: 1

ERROR_DISK_FULL

Added in API level 37

static val ERROR_DISK_FULL: Int

The operation failed because the disk is full.

This error is potentially transient if the user clears enough space on the storage device.

Value: 6

ERROR_INVALID_REQUEST

Added in API level 37

static val ERROR_INVALID_REQUEST: Int

The system cannot fulfill the request as configured.

This error is permanent as it indicates a malformed or invalid request.

Value: 2

ERROR_NONE

Added in API level 37

static val ERROR_NONE: Int

Successful operation.

Value: -1

ERROR_PERMISSION_DENIED

Added in API level 37

static val ERROR_PERMISSION_DENIED: Int

The operation failed due to missing permissions.

This error is permanent unless the user manually grants the required permissions.

Value: 5

ERROR_UNKNOWN

Added in API level 37

static val ERROR_UNKNOWN: Int

An unknown error.

Value: 0

ERROR_UNSUPPORTED_SOURCE

Added in API level 37

static val ERROR_UNSUPPORTED_SOURCE: Int

The source of the operation is unsupported or invalid.

This error is permanent as it indicates an issue with the request.

Value: 3

ERROR_UNSUPPORTED_TARGET

Added in API level 37

static val ERROR_UNSUPPORTED_TARGET: Int

The target of the operation is unsupported or invalid.

This error is permanent as it indicates an issue with the request.

Value: 4

STATUS_FAILED

Added in API level 37

static val STATUS_FAILED: Int

The operation failed.

Value: 4

STATUS_FINISHED

Added in API level 37

static val STATUS_FINISHED: Int

The operation finished successfully.

Value: 3

STATUS_IN_PROGRESS

Added in API level 37

static val STATUS_IN_PROGRESS: Int

The operation is currently running.

Value: 2

STATUS_QUEUED

Added in API level 37

static val STATUS_QUEUED: Int

The operation is queued and waiting to start.

Value: 1

STATUS_UNKNOWN

Added in API level 37

static val STATUS_UNKNOWN: Int

Unknown status.

Value: 0

Public methods

describeContents

Added in API level 37

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getErrorCode

Added in API level 37

fun getErrorCode(): Int

Returns the error code if the operation failed.

Return
Int	Value is one of the following: ERROR_NONE ERROR_UNKNOWN ERROR_BUSY ERROR_INVALID_REQUEST ERROR_UNSUPPORTED_SOURCE ERROR_UNSUPPORTED_TARGET ERROR_PERMISSION_DENIED ERROR_DISK_FULL

getErrorMessage

Added in API level 37

fun getErrorMessage(): String?

Returns the error message if the operation failed.

Return
String?	This value may be null.

getFailedPaths

Added in API level 37

fun getFailedPaths(): MutableList<String!>

Returns the list of failures.

This list is only populated when the operation reaches a terminal state (STATUS_FINISHED or STATUS_FAILED).

Note: Due to binder transaction limits, this list can truncate the total number of reported failures. If failures occurred, only the first android.os.storage.FileManager#getMaxReportedFailures are reported.

Return
MutableList<String!>	This value cannot be null.

getRequestId

Added in API level 37

fun getRequestId(): String

Returns the unique ID of the request.

Return
String	This value cannot be null.

getSource

Added in API level 37

fun getSource(): OperationSource

Returns the OperationSource that was configured in the original FileOperationRequest.

For example, if an operation was created using a AppDataFileSource that object would be returned here.

Return
OperationSource	This value cannot be null.

getStatus

Added in API level 37

fun getStatus(): Int

Returns the current status of the operation.

Return
Int	Value is one of the following: STATUS_UNKNOWN STATUS_QUEUED STATUS_IN_PROGRESS STATUS_FINISHED STATUS_FAILED

getTarget

Added in API level 37

fun getTarget(): OperationTarget?

Returns the target of the file operation.

Return
OperationTarget?	This value may be null.

writeToParcel

Added in API level 37

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

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 37

static val CREATOR: Parcelable.Creator<FileOperationResult!>