Added in API level 30

BlobHandle


class BlobHandle : Parcelable
kotlin.Any
   ↳ android.app.blob.BlobHandle

An identifier to represent a blob.

Summary

Inherited constants
Public methods
static BlobHandle
createWithSha256(digest: ByteArray, label: CharSequence, expiryTimeMillis: Long, tag: String)

Create a new blob identifier.

Int

Boolean
equals(other: Any?)

Long

Returns the expiry time in milliseconds of the blob that this object is representing, in System#currentTimeMillis() timebase.

CharSequence

Returns the label associated with the blob that this object is representing.

ByteArray

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

String

Returns the opaque String associated with the blob this object is representing.

Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<BlobHandle!>

Public methods

createWithSha256

Added in API level 30
static fun createWithSha256(
    digest: ByteArray,
    label: CharSequence,
    expiryTimeMillis: Long,
    tag: String
): BlobHandle

Create a new blob identifier.

For two objects of BlobHandle to be considered equal, the following arguments must be equal:

  • digest
  • label
  • expiryTimeMillis
  • tag
Parameters
digest ByteArray: the SHA-256 hash of the blob this is representing. This value cannot be null.
label CharSequence: a label indicating what the blob is, that can be surfaced to the user. The length of the label cannot be more than 100 characters. It is recommended to keep this brief. This may be truncated and ellipsized if it is too long to be displayed to the user. This value cannot be null.
expiryTimeMillis Long: the time in secs after which the blob should be invalidated and not allowed to be accessed by any other app, in System#currentTimeMillis() timebase or 0 to indicate that there is no expiry time associated with this blob. Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.
tag String: an opaque String associated with the blob. The length of the tag cannot be more than 128 characters. This value cannot be null.
Return
BlobHandle a new instance of BlobHandle object. This value cannot be null.

describeContents

Added in API level 30
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 android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

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

getExpiryTimeMillis

Added in API level 30
fun getExpiryTimeMillis(): Long

Returns the expiry time in milliseconds of the blob that this object is representing, in System#currentTimeMillis() timebase.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Return
Long Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

getLabel

Added in API level 30
fun getLabel(): CharSequence

Returns the label associated with the blob that this object is representing.

Return
CharSequence This value cannot be null.

getSha256Digest

Added in API level 30
fun getSha256Digest(): ByteArray

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

Return
ByteArray This value cannot be null.

getTag

Added in API level 30
fun getTag(): String

Returns the opaque String associated with the blob this object is representing.

Return
String This value cannot be null.

hashCode

Added in API level 30
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 30
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 30
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 30
static val CREATOR: Parcelable.Creator<BlobHandle!>