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 |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Long |
Returns the expiry time in milliseconds of the blob that this object is representing, in |
| CharSequence |
getLabel()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 |
getTag()Returns the opaque |
| Int |
hashCode()Returns a hash code value for the object. |
| 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<BlobHandle!> | |
Public methods
createWithSha256
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
fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getExpiryTimeMillis
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
fun getLabel(): CharSequence
Returns the label associated with the blob that this object is representing.
| Return | |
|---|---|
CharSequence |
This value cannot be null. |
getSha256Digest
fun getSha256Digest(): ByteArray
Returns the SHA-256 hash of the blob that this object is representing.
| Return | |
|---|---|
ByteArray |
This value cannot be null. |
getTag
fun getTag(): String
Returns the opaque String associated with the blob this object is representing.
| Return | |
|---|---|
String |
This value cannot be null. |
hashCode
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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:
|