OpenBlobForReadResponse

Kotlin |Java

class OpenBlobForReadResponse : Closeable, Parcelable

kotlin.Any
↳	android.app.appsearch.OpenBlobForReadResponse

The response to provide batch operation results of AppSearchSession.openBlobForRead.

This class is used to retrieve the result of a batch read operation on a collection of blob handles.

The returned android.os.ParcelFileDescriptor must be closed after use to avoid resource leaks. Failing to close the descriptor will result in system resource exhaustion, as each open android.os.ParcelFileDescriptor occupies a limited file descriptor in the system.

Summary

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 constructors
`OpenBlobForReadResponse(result: AppSearchBatchResult<AppSearchBlobHandle!, ParcelFileDescriptor!>)` Creates a `OpenBlobForReadResponse` with given `AppSearchBatchResult`.

Public methods
Unit	`close()`
AppSearchBatchResult<AppSearchBlobHandle!, ParcelFileDescriptor!>	`getResult()` Returns the `AppSearchBatchResult` object containing the results of the read blob for read operation for each `AppSearchBlobHandle`.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<OpenBlobForReadResponse!>	`CREATOR`

Public constructors

OpenBlobForReadResponse

Added in API level Baklava

OpenBlobForReadResponse(result: AppSearchBatchResult<AppSearchBlobHandle!, ParcelFileDescriptor!>)

Creates a OpenBlobForReadResponse with given AppSearchBatchResult.

Parameters
`result`	AppSearchBatchResult<AppSearchBlobHandle!, ParcelFileDescriptor!>: This value cannot be `null`.

Public methods

close

Added in API level Baklava

fun close(): Unit

Exceptions
`java.lang.Exception`	if this resource cannot be closed
`java.io.IOException`	if an I/O error occurs

getResult

Added in API level Baklava

fun getResult(): AppSearchBatchResult<AppSearchBlobHandle!, ParcelFileDescriptor!>

Returns the AppSearchBatchResult object containing the results of the read blob for read operation for each AppSearchBlobHandle.

Return
`AppSearchBatchResult<AppSearchBlobHandle!, ParcelFileDescriptor!>`	A `AppSearchBatchResult` maps `AppSearchBlobHandle`s which is a unique identifier for a specific blob being committed to the outcome of that read operation. If the operation was successful, the result for that handle is `ParcelFileDescriptor`; if there was an error, the result contains an `AppSearchResult` with details of the failure. This value cannot be `null`.

writeToParcel

Added in API level Baklava

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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level Baklava

static val CREATOR: Parcelable.Creator<OpenBlobForReadResponse!>