RuleController

public final void addRule(@NonNull EmbeddingRule rule)

Registers a new rule, or updates an existing rule if the tag has been registered with RuleController. Will be cleared automatically when the process is stopped.

Registering a SplitRule may fail if the SplitController.splitSupportStatus returns false. If not supported, it could be either because androidx.window.WindowProperties.PROPERTY_ACTIVITY_EMBEDDING_SPLITS_ENABLED not enabled in AndroidManifest or the feature not available on the device.

Note that registering a new rule or updating the existing rule will not be applied to any existing split activity container, and will only be used for new split containers created with future activity launches.

public final void clearRules()

Clears the rules previously registered by addRule or setRules.

public static final @NonNull RuleController getInstance(@NonNull Context context)

Obtains an instance of RuleController.

public final @NonNull Set<@NonNull EmbeddingRule> getRules()

Returns a copy of the currently registered rules.

public static final @NonNull Set<@NonNull EmbeddingRule> parseRules(@NonNull Context context, @XmlRes int staticRuleResourceId)

Parses EmbeddingRules from XML rule definitions.

The EmbeddingRules can then set by setRules.

public final void removeRule(@NonNull EmbeddingRule rule)

Unregisters a rule that was previously registered via addRule or setRules.

public final void setRules(@NonNull Set<@NonNull EmbeddingRule> rules)

Sets a set of EmbeddingRules, which replace all rules registered by addRule or setRules.

It's recommended to set the rules via an androidx.startup.Initializer, or android.app.Application.onCreate, so that they are applied early in the application startup before any activities appear.

The EmbeddingRules can be parsed from parseRules or built with rule Builders, which are:

• SplitPairRule.Builder

• SplitPlaceholderRule.Builder

• ActivityRule.Builder

Registering SplitRules may fail if the SplitController.splitSupportStatus returns false. If not supported, it could be either because androidx.window.WindowProperties.PROPERTY_ACTIVITY_EMBEDDING_SPLITS_ENABLED not enabled in AndroidManifest or the feature not available on the device.

Note that updating the existing rules will not be applied to any existing split activity container, and will only be used for new split containers created with future activity launches.