AppSearchBlobHandle

Kotlin |Java

class AppSearchBlobHandle : Parcelable

kotlin.Any
↳	android.app.appsearch.AppSearchBlobHandle

An identifier to represent a blob in AppSearch.

A "blob" is a large binary object. It is used to store a significant amount of data that is not searchable, such as images, videos, audio files, or other binary data. Unlike other fields in AppSearch, blobs are stored as blob files on disk rather than in memory, and use to read and write. This allows for efficient handling of large, non-searchable content.

AppSearchBlobHandle is a light-weight Property of GenericDocument, which is a pointer to the heavy-weight blob data.

The blob data could be written via AppSearchSession.openBlobForWrite and read via AppSearchSession.openBlobForRead.

A GenericDocument with AppSearchBlobHandle Property could be put and read without the large blob data. This offers lazy retrieval to blob data when searching GenericDocument in AppSearch.

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 methods
static AppSearchBlobHandle	`createWithSha256(digest: ByteArray, packageName: String, databaseName: String, namespace: String)` Create a new AppSearch blob identifier with given digest, package, database and namespace.
Boolean	`equals(other: Any?)`
String	`getDatabaseName()` Returns the name of database stored the blob that this object is representing.
String	`getNamespace()` Returns the app-defined namespace this blob resides in.
String	`getPackageName()` Returns the package name indicating the owner app of the blob that this object is representing.
ByteArray	`getSha256Digest()` Returns the SHA-256 hash of the blob that this object is representing.
Int	`hashCode()`
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Public methods

createWithSha256

Added in API level Baklava

static fun createWithSha256(
    digest: ByteArray, 
    packageName: String, 
    databaseName: String, 
    namespace: String
): AppSearchBlobHandle

Create a new AppSearch blob identifier with given digest, package, database and namespace.

The package name and database name indicated where this blob will be stored. To write, commit or read this blob via AppSearchSession, it must match the package name and database name of AppSearchSession.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Parameters
`digest`	ByteArray: The SHA-256 hash of the blob this is representing. This value cannot be `null`.
`packageName`	String: The package name of the owner of this Blob. This value cannot be `null`.
`databaseName`	String: The database name of this blob to stored into. This value cannot be `null`.
`namespace`	String: The namespace of this blob resides in. This value cannot be `null`.

Return
`AppSearchBlobHandle`	a new instance of `AppSearchBlobHandle` object. This value cannot be `null`.

equals

Added in API level Baklava

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getDatabaseName

Added in API level Baklava

fun getDatabaseName(): String

Returns the name of database stored the blob that this object is representing.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Return
`String`	This value cannot be `null`.

getNamespace

Added in API level Baklava

fun getNamespace(): String

Returns the app-defined namespace this blob resides in.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Return
`String`	This value cannot be `null`.

getPackageName

Added in API level Baklava

fun getPackageName(): String

Returns the package name indicating the owner app of the blob that this object is representing.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Return
`String`	This value cannot be `null`.

getSha256Digest

Added in API level Baklava

fun getSha256Digest(): ByteArray

Returns the SHA-256 hash of the blob that this object is representing.

For two objects of AppSearchBlobHandle to be considered equal, the packageName, database, namespace and digest must be equal.

Return
`ByteArray`	This value cannot be `null`.

hashCode

Added in API level Baklava

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level Baklava

fun toString(): String

Returns a string representation of the object.

Return
`String`	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<AppSearchBlobHandle!>