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

ActivityScenarioRule

class ActivityScenarioRule<A : 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 getScenario. 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 .

This rule does not support calling scenario.getResult(). Use ActivityScenario.launchActivityForResult() when the Activity result is needed.

Example:

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

  @Test
  public void myTest() {
    ActivityScenario

Summary

Public constructors

ActivityScenarioRule(activityClass: Class<A!>!)

Constructs ActivityScenarioRule for a given activity class.

ActivityScenarioRule(startActivityIntent: Intent!)

Constructs ActivityScenarioRule with a given intent.

ActivityScenarioRule(activityClass: Class<A!>!, activityOptions: Bundle!)
ActivityScenarioRule(
    startActivityIntent: Intent!,
    activityOptions: Bundle!
)

Public functions

ActivityScenario<A>!

Returns ActivityScenario of the given activity class.

Public constructors

ActivityScenarioRule

ActivityScenarioRule(activityClass: Class<A!>!)

Constructs ActivityScenarioRule for a given activity class.

Parameters
activityClass: Class<A!>!

an activity class to launch

ActivityScenarioRule

ActivityScenarioRule(startActivityIntent: Intent!)

Constructs ActivityScenarioRule with a given intent.

Parameters
startActivityIntent: Intent!

an intent to start an activity

ActivityScenarioRule

ActivityScenarioRule(activityClass: Class<A!>!, activityOptions: Bundle!)
Parameters
activityOptions: Bundle!

an activity options bundle to be passed along with the intent to start activity.

See also
ActivityScenarioRule

ActivityScenarioRule

ActivityScenarioRule(
    startActivityIntent: Intent!,
    activityOptions: Bundle!
)
Parameters
activityOptions: Bundle!

an activity options bundle to be passed along with the intent to start activity.

See also
ActivityScenarioRule

Public functions

getScenario

fun getScenario(): ActivityScenario<A>!

Returns ActivityScenario of the given activity class.

Returns
ActivityScenario<A>!

a non-null ActivityScenario instance

Throws
java.lang.NullPointerException: java.lang.NullPointerException

if you call this method while test is not running