Added in API level 37

FileOperationRequest

Kotlin |Java

public final class FileOperationRequest
extends Object implements Parcelable

java.lang.Object
↳	android.os.storage.operations.FileOperationRequest

Encapsulates a request to Move, or Copy files.

See also:

android.os.storage.FileManager.enqueueOperation(FileOperationRequest)

Summary

Nested classes
`class`	`FileOperationRequest.Builder` Builder for constructing `FileOperationRequest` instances.

Constants
`int`	`OPERATION_COPY` Operation mode indicating that files should be copied from the source to the target.
`int`	`OPERATION_MOVE` Operation mode indicating that files should be moved from the source to the target.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<FileOperationRequest>`	`CREATOR`

Public methods
`int`	`describeContents()` implemented for Parcelable
`int`	`getMode()` Returns the type of file operation to be performed for this request.
`OperationSource`	`getSource()` Returns the source of the file operation.
`OperationTarget`	`getTarget()` Returns the target of the file operation.
`boolean`	`shouldRegisterCompletionListener()` Returns true if a completion listener should be automatically registered for this request.
`void`	`writeToParcel(Parcel dest, int flags)` implemented for Parcelable

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

OPERATION_COPY

Added in API level 37

public static final int OPERATION_COPY

Operation mode indicating that files should be copied from the source to the target.

A copy operation creates duplicates of the files from the OperationSource at the destination specified by the OperationTarget, while the original files remain unchanged at the source.

Constant Value: 2 (0x00000002)

OPERATION_MOVE

Added in API level 37

public static final int OPERATION_MOVE

Operation mode indicating that files should be moved from the source to the target.

A move operation results in the files being transferred to the destination specified by the OperationTarget and subsequently removed from the OperationSource.

Note: While a move will be attempted, it is possible that this still results in standard Copy + Delete behavior, as the Source/Target may not be on the same underlying storage volume.

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 37

public static final Creator<FileOperationRequest> CREATOR

Public methods

describeContents

Added in API level 37

public int describeContents ()

implemented for Parcelable

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

getMode

Added in API level 37

public int getMode ()

Returns the type of file operation to be performed for this request.

Returns
`int`	The operation mode, which will be either `OPERATION_MOVE` or `OPERATION_COPY`. Value is one of the following: `OPERATION_MOVE` `OPERATION_COPY`

getSource

Added in API level 37

public OperationSource getSource ()

Returns the source of the file operation.

Returns
`OperationSource`	This value cannot be `null`.

getTarget

Added in API level 37

public OperationTarget getTarget ()

Returns the target of the file operation.

Returns
`OperationTarget`	This value may be `null`.

shouldRegisterCompletionListener

Added in API level 37

public boolean shouldRegisterCompletionListener ()

Returns true if a completion listener should be automatically registered for this request.

Returns
`boolean`

writeToParcel

Added in API level 37

public void writeToParcel (Parcel dest, 
                int flags)

implemented for Parcelable

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

FileOperationRequest

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

OPERATION_COPY

OPERATION_MOVE

Fields

CREATOR

Public methods

describeContents

getMode

getSource

getTarget

shouldRegisterCompletionListener

writeToParcel