Added in API level 36
Also in T Extensions 17

AppSearchBlobHandle

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 android.os.ParcelFileDescriptor 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
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.
Int

Boolean
equals(other: Any?)

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

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

Returns the app-defined namespace this blob resides in.
String

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

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

Returns a hash code value for the object.
String

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!>

Public methods

createWithSha256

Added in API level 36
Also in T Extensions 17
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.

describeContents

Added in API level 36
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 36
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.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getDatabaseName

Added in API level 36
Also in T Extensions 17
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 36
Also in T Extensions 17
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 36
Also in T Extensions 17
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 36
Also in T Extensions 17
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 36
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

toString

Added in API level 36
fun toString(): String

Returns a string representation of the object.

Return
String This value cannot be null.

writeToParcel

Added in API level 36
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:

Properties

CREATOR

Added in API level 36
Also in T Extensions 17
static val CREATOR: Parcelable.Creator<AppSearchBlobHandle!>