AppFunctionState

Kotlin |Java

public final 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 methods
`boolean`	`equals(Object other)`
`final ArraySet<@NonNull AppFunctionActivityId>`	`@RequiresApi(value = 37) getActivityIds()` The `android.app.appfunctions.AppFunctionActivityId`s this app function is associated with.
`final @NonNull AppFunctionName`	`getFunctionName()` The `AppFunctionName` associated with this state.
`int`	`hashCode()`
`final boolean`	`isEnabled()` Whether this app function can be executed.
`@NonNull String`	`toString()`

public boolean equals(Object other)

@RequiresApi(value = 37)
public final ArraySet<@NonNull AppFunctionActivityId> getActivityIds()

public final @NonNull AppFunctionName getFunctionName()

The AppFunctionName associated with this state.

public int hashCode()

public final boolean isEnabled()

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.

public @NonNull String toString()