{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

ActivityScenarioRule

public final class ActivityScenarioRule<A extends Activity>

ActivityScenarioRule launches a given activity before the test starts and closes after the test.

You can access the androidx.test.core.app.ActivityScenario instance via . You may finish your activity manually in your test, it will not cause any problems and this rule does nothing after the test in such cases.

This rule is an upgraded version of the now deprecated .

Example:

  @Rule
  public ActivityScenarioRulerule = new ActivityScenarioRule<>(MyActivity.class);

  @Test
  public void myTest() {
    ActivityScenario

Summary

Public constructors
`ActivityScenarioRule(@NonNull Class<@NonNull A> activityClass)` Constructs ActivityScenarioRule for a given activity class.
`ActivityScenarioRule(@NonNull Intent startActivityIntent)` Constructs ActivityScenarioRule with a given intent.
`ActivityScenarioRule( @NonNull Class<@NonNull A> activityClass, @NonNull Bundle activityOptions )`
`ActivityScenarioRule( @NonNull Intent startActivityIntent, @NonNull Bundle activityOptions )`

Public methods
`@NonNull ActivityScenario<A>`	`getScenario()` Returns ActivityScenario of the given activity class.

Public constructors

ActivityScenarioRule

public ActivityScenarioRule(@NonNull Class<@NonNull A> activityClass)

Constructs ActivityScenarioRule for a given activity class.

Parameters
`@NonNull Class<@NonNull A> activityClass`	an activity class to launch

ActivityScenarioRule

public ActivityScenarioRule(@NonNull Intent startActivityIntent)

Constructs ActivityScenarioRule with a given intent.

Parameters
`@NonNull Intent startActivityIntent`	an intent to start an activity

ActivityScenarioRule

public ActivityScenarioRule(
    @NonNull Class<@NonNull A> activityClass,
    @NonNull Bundle activityOptions
)

Parameters
`@NonNull Bundle activityOptions`	an activity options bundle to be passed along with the intent to start activity.

See also
`ActivityScenarioRule`	#ActivityScenarioRule(Class)

ActivityScenarioRule

public ActivityScenarioRule(
    @NonNull Intent startActivityIntent,
    @NonNull Bundle activityOptions
)

Parameters
`@NonNull Bundle activityOptions`	an activity options bundle to be passed along with the intent to start activity.

See also
`ActivityScenarioRule`	#ActivityScenarioRule(Intent)

Public methods

getScenario

@NonNull
public ActivityScenario<A> getScenario()

Returns ActivityScenario of the given activity class.

Returns
`ActivityScenario<A>`	a non-null ActivityScenario instance

Throws
`java.lang.NullPointerException`	if you call this method while test is not running