AppFunctionState
class AppFunctionState : Parcelable
| kotlin.Any | |
| ↳ | android.app.appfunctions.AppFunctionState |
Runtime state of an app function, retrieved using AppFunctionManager.getAppFunctionStates.
This holds properties of an app function that can change at runtime during the app's operation, such as whether the function is enabled.
This is distinct from AppFunctionMetadata, which represents the metadata that remains constant until the providing package is updated. While AppFunctionMetadata defines what a function is, the AppFunctionState defines its current operational status.
Summary
| 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. |
| ArraySet<AppFunctionActivityId!>? |
Returns |
| AppFunctionName |
Returns the |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean |
Returns whether this app function can be executed. |
| 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<AppFunctionState!> | |
Public 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. |
getActivityIds
fun getActivityIds(): ArraySet<AppFunctionActivityId!>?
Returns AppFunctionActivityIds this app function is associated with, or null if none.
This will only be non-null when AppFunctionMetadata.getScope is AppFunctionMetadata.SCOPE_ACTIVITY. See AppFunctionMetadata.SCOPE_ACTIVITY for more details.
getFunctionName
fun getFunctionName(): AppFunctionName
Returns the AppFunctionName associated with this state.
| Return | |
|---|---|
AppFunctionName |
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. |
isEnabled
fun isEnabled(): Boolean
Returns whether this app function can be executed.
This can be false if:
- The app disabled the function with
AppFunctionManager.setAppFunctionEnabled. - The function is disabled by default using
AppFunctionMetadata.PROPERTY_ENABLED_BY_DEFAULTand was never enabled. - The associated
AppFunctionServiceis disabled. - A function without an associated
AppFunctionServicehas not been registered usingAppFunctionManager.registerAppFunction, or has been unregistered. - The process registering the function using
AppFunctionManager.registerAppFunctionis frozen, or theandroid.content.Contextused to register it has been destroyed.
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:
|