ActionResult
class ActionResult : Parcelable
| kotlin.Any | |
| ↳ | android.companion.ActionResult |
A result reported by a companion app in response to an ActionRequest.
Summary
| Nested classes | |
|---|---|
|
Builder for creating an |
|
| Constants | |
|---|---|
| static Int |
A result code indicating that the requested activation was completed successfully. |
| static Int |
A result code indicating that a previously active action is now inactive. |
| static Int |
A result code indicating that the requested activation failed. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| 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. |
| Int | |
| Int | |
| 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<ActionResult!> | |
Constants
RESULT_ACTIVATED
static val RESULT_ACTIVATED: Int
A result code indicating that the requested activation was completed successfully. This is sent in response to an ActionRequest.OP_ACTIVATE request.
Value: 0RESULT_DEACTIVATED
static val RESULT_DEACTIVATED: Int
A result code indicating that a previously active action is now inactive. This can be sent for two reasons: 1. As a successful response to an ActionRequest.OP_DEACTIVATE request. 2. Action was failed after initially succeed.
Value: 2RESULT_FAILED_TO_ACTIVATE
static val RESULT_FAILED_TO_ACTIVATE: Int
A result code indicating that the requested activation failed. This is sent in response to an ActionRequest.OP_ACTIVATE request.
Value: 1Public methods
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(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. |
getAction
fun getAction(): Int
| Return | |
|---|---|
Int |
the action this result refers to, e.g. ActionRequest.REQUEST_NEARBY_SCANNING. Value is one of the following: |
getResultCode
fun getResultCode(): Int
| Return | |
|---|---|
Int |
the result code, e.g., RESULT_ACTIVATED. Value is one of the following: |
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:
|