AppFunctionState

Kotlin |Java

class AppFunctionState

Runtime state of an app function.

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 androidx.appfunctions.metadata.AppFunctionMetadata, which represents the metadata that remains constant until the providing package is updated. While androidx.appfunctions.metadata.AppFunctionMetadata defines what a function is, the AppFunctionState defines its current operational status.

Summary

Public properties
`ArraySet<AppFunctionActivityId>?`	`activityIds` The `android.app.appfunctions.AppFunctionActivityId`s this app function is associated with.
`AppFunctionName`	`functionName` The `AppFunctionName` associated with this state.
`Boolean`	`isEnabled` Whether this app function can be executed.

open operator fun equals(other: Any?): Boolean

open fun hashCode(): Int

open fun toString(): String

val activityIds: ArraySet<AppFunctionActivityId>?

val functionName: AppFunctionName

The AppFunctionName associated with this state.

val isEnabled: Boolean

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 android.app.appfunctions.AppFunctionMetadata.PROPERTY_ENABLED_BY_DEFAULT and was never enabled.
A function without an associated AppFunctionService has not been registered using AppFunctionManager.registerAppFunction or has been unregistered.
The process registering the function using AppFunctionManager.registerAppFunction is frozen, or the android.content.Context used to register it has been destroyed.