FragmentScenario

fun Fragment> launch(
    fragmentClass: Class,
    fragmentArgs: Bundle?,
    factory: FragmentFactory?
): FragmentScenario

Launches a Fragment with given arguments hosted by an empty FragmentActivity using the given FragmentFactory and waits for it to reach the resumed state.

This method cannot be called from the main thread.

fun Fragment> launch(
    fragmentClass: Class,
    fragmentArgs: Bundle?,
    themeResId: @StyleRes Int,
    factory: FragmentFactory?
): FragmentScenario

Launches a Fragment with given arguments hosted by an empty FragmentActivity themed by themeResId, using the given FragmentFactory and waits for it to reach the resumed state.

This method cannot be called from the main thread.

fun Fragment> launch(
    fragmentClass: Class,
    fragmentArgs: Bundle? = null,
    themeResId: @StyleRes Int = R.style.FragmentScenarioEmptyFragmentActivityTheme,
    initialState: Lifecycle.State = Lifecycle.State.RESUMED,
    factory: FragmentFactory? = null
): FragmentScenario

Launches a Fragment with given arguments hosted by an empty FragmentActivity themed by themeResId, using the given FragmentFactory and waits for it to reach initialState.

This method cannot be called from the main thread.

fun Fragment> launchInContainer(
    fragmentClass: Class,
    fragmentArgs: Bundle?,
    factory: FragmentFactory?
): FragmentScenario

Launches a Fragment in the Activity's root view container android.R.id.content, with given arguments hosted by an empty FragmentActivity using the given FragmentFactory and waits for it to reach the resumed state.

This method cannot be called from the main thread.

fun Fragment> launchInContainer(
    fragmentClass: Class,
    fragmentArgs: Bundle?,
    themeResId: @StyleRes Int,
    factory: FragmentFactory?
): FragmentScenario

Launches a Fragment in the Activity's root view container android.R.id.content, with given arguments hosted by an empty FragmentActivity themed by themeResId, using the given FragmentFactory and waits for it to reach the resumed state.

This method cannot be called from the main thread.

fun Fragment> launchInContainer(
    fragmentClass: Class,
    fragmentArgs: Bundle? = null,
    themeResId: @StyleRes Int = R.style.FragmentScenarioEmptyFragmentActivityTheme,
    initialState: Lifecycle.State = Lifecycle.State.RESUMED,
    factory: FragmentFactory? = null
): FragmentScenario

Launches a Fragment in the Activity's root view container android.R.id.content, with given arguments hosted by an empty FragmentActivity themed by themeResId, using the given FragmentFactory and waits for it to reach initialState.

This method cannot be called from the main thread.

open fun close(): Unit

Finishes the managed fragments and cleans up device's state. This method blocks execution until the host activity becomes Lifecycle.State.DESTROYED.

fun moveToState(newState: Lifecycle.State): FragmentScenario

Moves Fragment state to a new state.

If a new state and current state are the same, this method does nothing. It accepts all Lifecycle.States. DESTROYED is a terminal state. You cannot move to any other state after the Fragment reaches that state.

This method cannot be called from the main thread.

fun onFragment(action: FragmentScenario.FragmentAction): FragmentScenario

Runs a given action on the current Activity's main thread.

Note that you should never keep Fragment reference passed into your action because it can be recreated at anytime during state transitions.

Throwing an exception from action makes the host Activity crash. You can inspect the exception in logcat outputs.

This method cannot be called from the main thread.

fun recreate(): FragmentScenario

Recreates the host Activity.

After this method call, it is ensured that the Fragment state goes back to the same state as its previous state.

This method cannot be called from the main thread.

inline fun Fragment, T : Any> FragmentScenario.withFragment(
    crossinline block: F.() -> T
): T

Run block using FragmentScenario.onFragment, returning the result of the block.

If any exceptions are raised while running block, they are rethrown.