Robolectric

https://robolectric.org/
Admin
Robolectric is a framework that brings fast and reliable unit tests to Android, allowing tests to...
Tokens:2,067,373
Snippets:27,687
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### startPackageInstallerSessionDetailsActivity

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowLauncherApps.html

Starts the package installer session details activity.

```APIDOC
## startPackageInstallerSessionDetailsActivity

### Description
Starts the package installer session details activity.

### Method
startPackageInstallerSessionDetailsActivity

### Parameters
- `sessionInfo` (PackageInstaller.SessionInfo) - Required - The session info.
- `sourceBounds` (Rect) - Optional - The source bounds.
- `opts` (Bundle) - Optional - The options.

```

--------------------------------

### start()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowMediaRecorder.html

Starts recording.

```APIDOC
## start()

### Description
Starts recording.

### Method
`protected void start()`

### Parameters
None.

### Return Value
- `void`
```

--------------------------------

### startPackageInstallerSessionDetailsActivity(PackageInstaller.SessionInfo, Rect, Bundle) - ShadowLauncherApps

Source: https://robolectric.org/javadoc/latest/index-all.html

Method in class org.robolectric.shadows.ShadowLauncherApps. Starts the package installer session details activity.

```APIDOC
## startPackageInstallerSessionDetailsActivity(PackageInstaller.SessionInfo, Rect, Bundle)

### Description
Method in class org.robolectric.shadows.ShadowLauncherApps. Starts the package installer session details activity.

### Method
startPackageInstallerSessionDetailsActivity

### Signature
`public void startPackageInstallerSessionDetailsActivity(PackageInstaller.SessionInfo sessionInfo, Rect sourceBounds, Bundle opts)`

### Parameters
- **sessionInfo** (PackageInstaller.SessionInfo) - Required - The session info.
- **sourceBounds** (Rect) - Required - The source bounds.
- **opts** (Bundle) - Required - The options bundle.

```

--------------------------------

### start() - Method in class org.robolectric.simulator.Simulator

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the simulator.

```APIDOC
## start() - Method in Simulator

### Description
Starts the simulator.
```

--------------------------------

### start(Path output, int width, int height, ScreenRecorder.FrameRate frameRate)

Source: https://robolectric.org/javadoc/latest/org/robolectric/simulator/pluginapi/NoOpScreenRecorder.html

Starts the screen recorder. This implementation does nothing, as it is a no-op.

```APIDOC
## start(Path output, int width, int height, ScreenRecorder.FrameRate frameRate)

### Description
Starts the screen recorder. This is a no-op implementation.

### Method
`public void start(Path output, int width, int height, ScreenRecorder.FrameRate frameRate)`

### Parameters
- **output** (Path) - Required - The output path for the recording.
- **width** (int) - Required - The width of the recording.
- **height** (int) - Required - The height of the recording.
- **frameRate** (ScreenRecorder.FrameRate) - Required - The frame rate for the recording.

### Returns
void
```

--------------------------------

### start()

Source: https://robolectric.org/javadoc/latest/org/robolectric/android/controller/FragmentController.html

Starts the fragment.

```APIDOC
## start()

### Description
Starts the fragment.

### Method
start

### Signature
`public FragmentController<F> start()`

### Returns
- **FragmentController<F>** - This controller.

### Deprecation
Deprecated. Use FragmentScenario instead.
```

--------------------------------

### start() - Method in class org.robolectric.shadows.ShadowMediaRecorder

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the media recorder shadow.

```APIDOC
## start() - Method in ShadowMediaRecorder

### Description
Starts the media recorder shadow.
```

--------------------------------

### start(Path output, int width, int height, ScreenRecorder.FrameRate frameRate)

Source: https://robolectric.org/javadoc/latest/org/robolectric/simulator/pluginapi/ScreenRecorder.html

Starts the screen recorder with the specified output path, dimensions, and frame rate.

```APIDOC
## start(Path output, int width, int height, ScreenRecorder.FrameRate frameRate)

### Description
Start the screen recorder.

### Method
void start(Path output, int width, int height, ScreenRecorder.FrameRate frameRate)

### Parameters
- **output** (Path) - The output path for the recording.
- **width** (int) - The width of the recording.
- **height** (int) - The height of the recording.
- **frameRate** (ScreenRecorder.FrameRate) - The frame rate for the recording.

### Returns
void
```

--------------------------------

### start() - Method in class org.robolectric.shadows.ShadowVideoView

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the video view shadow.

```APIDOC
## start() - Method in ShadowVideoView

### Description
Starts the video view shadow.
```

--------------------------------

### start(Path, int, int, ScreenRecorder.FrameRate) - Method in class org.robolectric.simulator.pluginapi.NoOpScreenRecorder

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the screen recorder with the given parameters.

```APIDOC
## start(Path, int, int, ScreenRecorder.FrameRate) - Method in NoOpScreenRecorder

### Description
Starts the screen recorder with the given parameters.
```

--------------------------------

### start()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowMediaPlayer.html

Simulates private native method MediaPlayer._start().

```APIDOC
## start()

### Description
Simulates private native method `MediaPlayer._start()`.

### Method
start

### Parameters
None.

```

--------------------------------

### start(Path, int, int, ScreenRecorder.FrameRate) - Method in interface org.robolectric.simulator.pluginapi.ScreenRecorder

Source: https://robolectric.org/javadoc/latest/index-all.html

Start the screen recorder.

```APIDOC
## start(Path, int, int, ScreenRecorder.FrameRate) - Method in ScreenRecorder

### Description
Start the screen recorder.
```

--------------------------------

### doStart()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowMediaPlayer.html

Starts simulated playback.

```APIDOC
## doStart()

### Description
Starts simulated playback.

### Method
void

```

--------------------------------

### onCreate(Bundle arguments)

Source: https://robolectric.org/javadoc/latest/org/robolectric/android/internal/RoboMonitoringInstrumentation.html

Sets up lifecycle monitoring and argument registry. Subclasses must call up to onCreate(). This onCreate method does not call start(); it is the subclass's responsibility to call start if desired.

```APIDOC
## Method: onCreate(Bundle arguments)

### Description
Sets up lifecycle monitoring and argument registry. Subclasses must call up to onCreate(). This onCreate method does not call start(); it is the subclass's responsibility to call start if desired.

### Signature
`public void onCreate(Bundle arguments)`

### Parameters
- **arguments** (Bundle) - Required - The arguments passed to the instrumentation.

### Returns
void
```

--------------------------------

### start()

Source: https://robolectric.org/javadoc/latest/org/robolectric/android/controller/FragmentController.html

Deprecated method that starts the fragment.

```APIDOC
## start()

### Description
Deprecated method that starts the fragment.

### Method
start

### Signature
`public FragmentController<F> start()`

### Returns
- `FragmentController<F>` - This controller.

### Deprecation
Deprecated.
```

--------------------------------

### start() - Method in class org.robolectric.android.controller.ActivityController

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the activity controller.

```APIDOC
## start() - Method in ActivityController

### Description
Starts the activity controller.
```

--------------------------------

### startCommand(int flags, int startId)

Source: https://robolectric.org/javadoc/latest/org/robolectric/android/controller/ServiceController.html

Starts the service with the given flags and start ID.

```APIDOC
## startCommand(int flags, int startId)

### Description
Starts the service with the given flags and start ID.

### Method
startCommand

### Signature
`public ServiceController<T> startCommand(int flags, int startId)`

### Parameters
- **flags** (int) - Required - The flags for the start command.
- **startId** (int) - Required - The start ID for the start command.

### Returns
- **ServiceController<T>** - This controller for chaining.
```

--------------------------------

### startCommand(int flags, int startId)

Source: https://robolectric.org/javadoc/latest/org/robolectric/android/controller/IntentServiceController.html

Starts the service with the given command flags and start ID.

```APIDOC
## startCommand(int flags, int startId)

### Description
Starts the service with the specified flags and start ID, simulating the onStartCommand lifecycle method.

### Method
Instance method

### Signature
`public IntentServiceController<T> startCommand(int flags, int startId)`

### Parameters
- **flags** (int) - Required - Command flags for the start command.
- **startId** (int) - Required - Unique identifier for this start request.

### Returns
- **IntentServiceController<T>** - This controller for chaining.
```

--------------------------------

### startActivity(Context context, Intent intent, Bundle options)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowAppTask.html

Starts the activity using the given context. The started activity can be checked using ShadowContextWrapper.getNextStartedActivity().

```APIDOC
## startActivity(Context context, Intent intent, Bundle options)

### Description
Starts the activity using the given context. The started activity can be checked using ShadowContextWrapper.getNextStartedActivity().

### Method
startActivity

### Signature
@Implementation protected void startActivity(Context context, Intent intent, Bundle options)

### Parameters
- **context** (Context) - Required - Context with which the activity will be started.
- **intent** (Intent) - Required - Intent of the activity to be started.
- **options** (Bundle) - Required - Extras passed to the activity.
```

--------------------------------

### IntentServiceController.startCommand

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts a command on the IntentServiceController.

```APIDOC
## startCommand(int, int)

### Description
Starts a command on the IntentServiceController.

### Method
startCommand

### Parameters
- **startId** (int) - Required - The start ID.
- **flags** (int) - Required - The flags.
```

--------------------------------

### startDiscovery

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowBluetoothAdapter.html

Starts discovery of Bluetooth devices. Returns true if discovery successfully started.

```APIDOC
## startDiscovery

### Description
Starts discovery of Bluetooth devices. Returns true if discovery successfully started.

### Method
protected boolean startDiscovery()

### Parameters
None

### Returns
- **boolean** - true if discovery started successfully, false otherwise.
```

--------------------------------

### ActivityController.setup(Bundle)

Source: https://robolectric.org/javadoc/latest/org/robolectric/android/controller/ActivityController.html

Performs setup with a saved instance state, simulating restoration.

```APIDOC
## ActivityController<T> setup(Bundle)

### Description
Calls the same lifecycle methods on the Activity called by Android when an Activity is restored from previously saved state.

### Method
`public ActivityController<T> setup(Bundle savedInstanceState)`

### Parameters
- **savedInstanceState** (Bundle) - Required - Saved instance state.

### Returns
Activity controller instance.
```

--------------------------------

### startDiscovery()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowBluetoothAdapter.html

Starts discovery.

```APIDOC
## startDiscovery()

### Description
Starts discovery.

### Method
protected boolean startDiscovery()

### Parameters
None

### Returns
boolean - true if discovery started successfully, false otherwise.
```

--------------------------------

### setupLogging()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowLog.html

Sets up logging for the shadow.

```APIDOC
## setupLogging()

### Description
Sets up logging for the shadow.

### Method
setupLogging

### Signature
`public static void setupLogging()`

### Parameters
None.

### Returns
void
```

--------------------------------

### getInstalledProviders() - Method in class org.robolectric.shadows.ShadowAppWidgetManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed widget providers.

```APIDOC
## getInstalledProviders()

### Description
Method to get installed widget providers.

### Method
Instance

### Class
org.robolectric.shadows.ShadowAppWidgetManager
```

--------------------------------

### WelcomeActivityTest in Kotlin

Source: https://robolectric.org/writing-a-test

Robolectric test that verifies clicking the login button starts LoginActivity. Uses ActivityController to set up the activity and shadowOf to get the next started activity.

```kotlin
@RunWith(RobolectricTestRunner::class)
class WelcomeActivityTest {
    @Test
    fun clickingLogin_shouldStartLoginActivity() {
        Robolectric.buildActivity(WelcomeActivity::class.java).use { controller ->
            controller.setup() // Moves the Activity to the RESUMED state

            val activity = controller.get()
            activity.findViewById<Button>(R.id.login).performClick()

            val expectedIntent = Intent(activity, LoginActivity::class.java)
            val actual = shadowOf(RuntimeEnvironment.application).nextStartedActivity
            assertEquals(expectedIntent.component, actual.component)
        }
    }
}
```

--------------------------------

### setupLogging()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowLog.html

Sets up logging for the shadow.

```APIDOC
## setupLogging()

### Description
Sets up logging for the shadow.

### Method
setupLogging

### Return Type
void
```

--------------------------------

### WelcomeActivityTest in Java

Source: https://robolectric.org/writing-a-test

Robolectric test that verifies clicking the login button starts LoginActivity. Uses ActivityController to set up the activity and shadowOf to get the next started activity.

```java
@RunWith(RobolectricTestRunner.class)
public class WelcomeActivityTest {
    @Test
    public void clickingLogin_shouldStartLoginActivity() {
        try (ActivityController<WelcomeActivity> controller = Robolectric.buildActivity(WelcomeActivity.class)) {
            controller.setup(); // Moves the Activity to the RESUMED state

            WelcomeActivity activity = controller.get();
            activity.findViewById<Button>(R.id.login).performClick();

            Intent expectedIntent = new Intent(activity, LoginActivity.class);
            Intent actual = shadowOf(RuntimeEnvironment.application).getNextStartedActivity();
            assertEquals(expectedIntent.getComponent(), actual.getComponent());
        }
    }
}
```

--------------------------------

### ActivityController.setup()

Source: https://robolectric.org/javadoc/latest/org/robolectric/android/controller/ActivityController.html

Performs the initial setup of the activity, calling the lifecycle methods as on first creation.

```APIDOC
## ActivityController<T> setup

### Description
Calls the same lifecycle methods on the Activity called by Android the first time the Activity is created.

### Method
`public ActivityController<T> setup()`

### Returns
Activity controller instance.
```

--------------------------------

### getInstalledAccessibilityServiceList() - Method in class org.robolectric.shadows.ShadowAccessibilityManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get the installed accessibility service list.

```APIDOC
## getInstalledAccessibilityServiceList()

### Description
Method to get the installed accessibility service list.

### Method
Instance

### Class
org.robolectric.shadows.ShadowAccessibilityManager
```

--------------------------------

### ServiceController.startCommand

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts a command on the ServiceController.

```APIDOC
## startCommand(int, int)

### Description
Starts a command on the ServiceController.

### Method
startCommand

### Parameters
- **startId** (int) - Required - The start ID.
- **flags** (int) - Required - The flags.
```

--------------------------------

### install(File, long)

Source: https://robolectric.org/javadoc/latest/index-all.html

Static method in class org.robolectric.shadows.ShadowHttpResponseCache.

```APIDOC
## install(File, long)

### Description
Static method in class org.robolectric.shadows.ShadowHttpResponseCache.

### Method
install(File, long)

### Parameters
- **File** - The directory.
- **long** - The maximum size.
```

--------------------------------

### getInstalledPackages(Object) - Method in class org.robolectric.shadows.ShadowApplicationPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed packages with the given flags.

```APIDOC
## getInstalledPackages(Object)

### Description
Method to get installed packages with the given flags.

### Method
Instance

### Class
org.robolectric.shadows.ShadowApplicationPackageManager

### Parameters
#### Method Parameters
- **flags** (Object) - Required - Flags for the query.
```

--------------------------------

### getInstalledPackages(int) - Method in class org.robolectric.shadows.ShadowApplicationPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed packages with the given flags.

```APIDOC
## getInstalledPackages(int)

### Description
Method to get installed packages with the given flags.

### Method
Instance

### Class
org.robolectric.shadows.ShadowApplicationPackageManager

### Parameters
#### Method Parameters
- **flags** (int) - Required - Flags for the query.
```

--------------------------------

### ShadowBluetoothAdapter.startDiscovery

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts Bluetooth discovery.

```APIDOC
## startDiscovery()

### Description
Starts Bluetooth discovery.

### Method
startDiscovery

### Parameters
None
```

--------------------------------

### getInstalledModules(int) - Method in class org.robolectric.shadows.ShadowApplicationPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed modules with the given flags.

```APIDOC
## getInstalledModules(int)

### Description
Method to get installed modules with the given flags.

### Method
Instance

### Class
org.robolectric.shadows.ShadowApplicationPackageManager

### Parameters
#### Method Parameters
- **flags** (int) - Required - Flags for the query.
```

--------------------------------

### getInstalledApplications(Object) - Method in class org.robolectric.shadows.ShadowApplicationPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed applications with the given flags.

```APIDOC
## getInstalledApplications(Object)

### Description
Method to get installed applications with the given flags.

### Method
Instance

### Class
org.robolectric.shadows.ShadowApplicationPackageManager

### Parameters
#### Method Parameters
- **flags** (Object) - Required - Flags for the query.
```

--------------------------------

### setupLogging() - Static method in class org.robolectric.shadows.ShadowLog

Source: https://robolectric.org/javadoc/latest/index-all.html

Sets up logging for tests.

```APIDOC
## setupLogging()

### Description
Sets up logging for tests.

### Method
Static method in class `org.robolectric.shadows.ShadowLog`
```

--------------------------------

### getInstalledApplications(int) - Method in class org.robolectric.shadows.ShadowApplicationPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed applications with the given flags.

```APIDOC
## getInstalledApplications(int)

### Description
Method to get installed applications with the given flags.

### Method
Instance

### Class
org.robolectric.shadows.ShadowApplicationPackageManager

### Parameters
#### Method Parameters
- **flags** (int) - Required - Flags for the query.
```

--------------------------------

### getInstallSourceInfo(String) - Method in class org.robolectric.shadows.ShadowApplicationPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get install source info for a given package.

```APIDOC
## getInstallSourceInfo(String)

### Description
Method to get install source info for a given package.

### Method
Instance

### Class
org.robolectric.shadows.ShadowApplicationPackageManager

### Parameters
#### Method Parameters
- **packageName** (String) - Required - The package name.
```

--------------------------------

### ShadowDisplayManager example in Java

Source: https://robolectric.org/writing-a-test

Shows how to use a static shadow class to simulate a new display being plugged in.

```java
// Simulate a new display being plugged into the device
ShadowDisplayManager.addDisplay("xlarge-port");
```

--------------------------------

### getInstallerPackageName(String) - Method in class org.robolectric.shadows.ShadowApplicationPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get the installer package name for a given package.

```APIDOC
## getInstallerPackageName(String)

### Description
Method to get the installer package name for a given package.

### Method
Instance

### Class
org.robolectric.shadows.ShadowApplicationPackageManager

### Parameters
#### Method Parameters
- **packageName** (String) - Required - The package name.
```

--------------------------------

### getInstalled() - Static method in class org.robolectric.shadows.ShadowHttpResponseCache

Source: https://robolectric.org/javadoc/latest/index-all.html

Static method to get the installed HTTP response cache.

```APIDOC
## getInstalled()

### Description
Static method to get the installed HTTP response cache.

### Method
Static

### Class
org.robolectric.shadows.ShadowHttpResponseCache
```

--------------------------------

### getInstalledProvidersForProfile(UserHandle) - Method in class org.robolectric.shadows.ShadowAppWidgetManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed widget providers for a specific user profile.

```APIDOC
## getInstalledProvidersForProfile(UserHandle)

### Description
Method to get installed widget providers for a specific user profile.

### Method
Instance

### Class
org.robolectric.shadows.ShadowAppWidgetManager

### Parameters
#### Method Parameters
- **userHandle** (UserHandle) - Required - The user handle.
```

--------------------------------

### start() - Method in class org.robolectric.shadows.ShadowMediaPlayer

Source: https://robolectric.org/javadoc/latest/index-all.html

Simulates private native method `MediaPlayer._start()`.

```APIDOC
## start() - Method in ShadowMediaPlayer

### Description
Simulates private native method `MediaPlayer._start()`.
```

--------------------------------

### setupService(Class<T> serviceClass)

Source: https://robolectric.org/javadoc/latest/org/robolectric/Robolectric.html

Sets up a service of the given class and returns its reference. The service is created and its lifecycle is started.

```APIDOC
## setupService(Class<T> serviceClass)

### Description
Sets up a service of the given class and returns its reference. The service is created and its lifecycle is started.

### Method
setupService

### Signature
`public static <T extends Service> T setupService(Class<T> serviceClass)`

### Parameters
- **serviceClass** (Class<T>) - Required - The class of the service to set up.

### Returns
- **T** - The service instance.

```

--------------------------------

### getInstalledProvidersForPackage(String, UserHandle) - Method in class org.robolectric.shadows.ShadowAppWidgetManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed widget providers for a specific package and user.

```APIDOC
## getInstalledProvidersForPackage(String, UserHandle)

### Description
Method to get installed widget providers for a specific package and user.

### Method
Instance

### Class
org.robolectric.shadows.ShadowAppWidgetManager

### Parameters
#### Method Parameters
- **packageName** (String) - Required - The package name.
- **userHandle** (UserHandle) - Required - The user handle.
```

--------------------------------

### getInstalledPackagesAsUser(int, int) - Method in class org.robolectric.shadows.ShadowApplicationPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method to get installed packages for a specific user with the given flags.

```APIDOC
## getInstalledPackagesAsUser(int, int)

### Description
Method to get installed packages for a specific user with the given flags.

### Method
Instance

### Class
org.robolectric.shadows.ShadowApplicationPackageManager

### Parameters
#### Method Parameters
- **flags** (int) - Required - Flags for the query.
- **userId** (int) - Required - The user ID.
```

--------------------------------

### Robolectric 3.x style test with RobolectricTestRunner

Source: https://robolectric.org/blog/2018/10/25/robolectric-4-0

Example of a Robolectric test using the old RobolectricTestRunner and Robolectric.setupActivity, showing how to click a view and assert the next started activity's action.

```kotlin
@RunWith(RobolectricTestRunner::class)
class RobolectricTest {
  @Test fun clickingOnTitle_shouldLaunchEditAction() {
    val activity = Robolectric.setupActivity(NoteListActivity::class.java)
    ShadowView.clickOn(activity.findViewById(R.id.title))
    assertThat(ShadowApplication.getInstance().peekNextStartedActivity().action)
            .isEqualTo("android.intent.action.EDIT")
  }
}

```

--------------------------------

### Application: Robolectric RuntimeEnvironment (Java & Kotlin)

Source: https://robolectric.org/androidx_test

Get the application context with Robolectric’s RuntimeEnvironment.application, then cast to your app class to set a mock provider. Use in a @Before setup method.

```Java
import org.robolectric.RuntimeEnvironment;

@Before
void setUp() {
  ExampleApplication app = (ExampleApplication) RuntimeEnvironment.application;
  app.setLocationProvider(mockLocationProvider);
}


```

```Kotlin
import org.robolectric.RuntimeEnvironment

@Before
fun setUp() {
  val app = RuntimeEnvironment.application as ExampleApplication
  app.setLocationProvider(mockLocationProvider)
}


```

--------------------------------

### initialize(Context context, Looper looper, WifiP2pManager.ChannelListener listener)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowWifiP2pManager.html

Simulates initializing the Wi-Fi Direct framework. Returns a new WifiP2pManager.Channel instance.

```APIDOC
## initialize(Context context, Looper looper, WifiP2pManager.ChannelListener listener)

### Description
Simulates initializing the Wi-Fi Direct framework. Returns a new WifiP2pManager.Channel instance.

### Method
INITIALIZE

### Signature
`@Implementation protected WifiP2pManager.Channel initialize(Context context, Looper looper, WifiP2pManager.ChannelListener listener)`

### Parameters
- **context** (Context) - Required - The context to use for initialization.
- **looper** (Looper) - Required - The looper to use for the channel.
- **listener** (WifiP2pManager.ChannelListener) - Required - Listener for channel events.

### Returns
- **WifiP2pManager.Channel** - A new channel instance.

```

--------------------------------

### prepare()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowMediaPlayer.html

Simulates MediaPlayer.prepareAsync().

```APIDOC
## prepare()

### Description
Simulates MediaPlayer.prepareAsync().

### Method
protected void

```

--------------------------------

### setupService(Class<T>) - Static method in class org.robolectric.Robolectric

Source: https://robolectric.org/javadoc/latest/index-all.html

Sets up a service for testing.

```APIDOC
## setupService(Class<T>)

### Description
Sets up a service for testing.

### Method
Static method in class `org.robolectric.Robolectric`

### Parameters
- **serviceClass** (Class<T>) - Required - The service class to set up.
```

--------------------------------

### native_setup(Object audioEffectThis, String type, String uuid, int priority, int audioSession, int[] id, Object[] desc, String opPackageName)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowAudioEffect.html

Performs native setup for the AudioEffect. This is a protected method.

```APIDOC
## native_setup(Object audioEffectThis, String type, String uuid, int priority, int audioSession, int[] id, Object[] desc, String opPackageName)

### Description
Performs native setup for the AudioEffect.

### Method
native_setup

### Parameters
- **audioEffectThis** (Object) - Required - The AudioEffect instance.
- **type** (String) - Required - The effect type.
- **uuid** (String) - Required - The effect UUID.
- **priority** (int) - Required - The priority.
- **audioSession** (int) - Required - The audio session ID.
- **id** (int[]) - Required - Array to receive the effect ID.
- **desc** (Object[]) - Required - Array to receive the effect descriptor.
- **opPackageName** (String) - Required - The package name.

### Returns
int - Status code.
```

--------------------------------

### setupBackupAgent(Class<T>) - Static method in class org.robolectric.Robolectric

Source: https://robolectric.org/javadoc/latest/index-all.html

Sets up a backup agent for testing.

```APIDOC
## setupBackupAgent(Class<T>)

### Description
Sets up a backup agent for testing.

### Method
Static method in class `org.robolectric.Robolectric`

### Parameters
- **backupAgentClass** (Class<T>) - Required - The backup agent class to set up.
```

--------------------------------

### onSetupApplicationState()

Source: https://robolectric.org/javadoc/latest/org/robolectric/pluginapi/TestEnvironmentLifecyclePlugin.html

Runs additional setup during TestEnvironment.before(). This method is called by the test environment to allow plugins to perform custom initialization.

```APIDOC
## onSetupApplicationState()

### Description
Runs additional setup during TestEnvironment.before().

### Method
onSetupApplicationState

### Signature
void onSetupApplicationState()

### Parameters
None

### Return Value
void

### Usage
This method is called by the test environment to allow plugins to perform custom initialization before the application state is set up.
```

--------------------------------

### get(ConfigurationStrategy.Configuration)

Source: https://robolectric.org/javadoc/latest/org/robolectric/plugins/ConfigConfigurer.html

Static method to get a Config from a ConfigurationStrategy.Configuration.

```APIDOC
## Method: get(ConfigurationStrategy.Configuration)

### Description
Static method to get a Config from a ConfigurationStrategy.Configuration.

### Signature
public static Config get(ConfigurationStrategy.Configuration testConfig)

### Parameters
- **testConfig** (ConfigurationStrategy.Configuration) - Required - The test configuration.

### Returns
- **Config** - The resulting Config.

```

--------------------------------

### setUpApplicationState

Source: https://robolectric.org/javadoc/latest/org/robolectric/internal/TestEnvironment.html

Sets up the application state for a test run with the given temporary directory, configuration, and application manifest.

```APIDOC
## setUpApplicationState

### Description
Sets up the application state for a test run with the given temporary directory, configuration, and application manifest.

### Method
void

### Signature
`void setUpApplicationState(String tmpDirName, ConfigurationStrategy.Configuration config, AndroidManifest appManifest)`

### Parameters
- **tmpDirName** (String) - Required - The name of the temporary directory.
- **config** (ConfigurationStrategy.Configuration) - Required - The configuration for the test run.
- **appManifest** (AndroidManifest) - Required - The application manifest.

### Return Type
void
```

--------------------------------

### setupContentProvider(Class<T> contentProviderClass)

Source: https://robolectric.org/javadoc/latest/org/robolectric/Robolectric.html

Sets up a ContentProvider of the given class and returns its reference. The provider is created and its lifecycle is started.

```APIDOC
## setupContentProvider(Class<T> contentProviderClass)

### Description
Sets up a ContentProvider of the given class and returns its reference. The provider is created and its lifecycle is started.

### Method
setupContentProvider

### Signature
`public static <T extends ContentProvider> T setupContentProvider(Class<T> contentProviderClass)`

### Parameters
- **contentProviderClass** (Class<T>) - Required - The class of the ContentProvider to set up.

### Returns
- **T** - The ContentProvider instance.

```

--------------------------------

### start() - Method in class org.robolectric.shadows.ShadowCountDownTimer

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the count down timer shadow.

```APIDOC
## start() - Method in ShadowCountDownTimer

### Description
Starts the count down timer shadow.
```

--------------------------------

### startActivity(Intent, UserHandle, Activity, Bundle) - Implementation

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowCrossProfileApps.html

Simulates starting the activity specified in the specified profile, performing the same security checks done by the real CrossProfileApps.

```APIDOC
## startActivity(Intent, UserHandle, Activity, Bundle)

### Description
Simulates starting the activity specified in the specified profile, performing the same security checks done by the real `CrossProfileApps`. The most recent main activity started can be queried by `peekNextStartedActivity()`.

### Method
`@Implementation(minSdk=30) protected void startActivity(Intent intent, UserHandle targetUser, @Nullable Activity activity, @Nullable Bundle options)`

### Parameters
- **intent** (Intent) - The intent to start.
- **targetUser** (UserHandle) - The target user profile.
- **activity** (Activity) - The activity from which the start is initiated.
- **options** (Bundle) - Additional options for the activity start.
```

--------------------------------

### start() - Method in class org.robolectric.android.controller.FragmentController

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the fragment controller. Deprecated.

```APIDOC
## start() - Method in FragmentController

### Description
Starts the fragment controller.

### Deprecation
Deprecated.
```

--------------------------------

### START - Static variable in class org.robolectric.shadows.ShadowVideoView

Source: https://robolectric.org/javadoc/latest/index-all.html

Static variable START in ShadowVideoView.

```APIDOC
## START - Static variable in ShadowVideoView

### Description
Static variable START in ShadowVideoView.
```

--------------------------------

### setupContentProvider(Class<T>) - Static method in class org.robolectric.Robolectric

Source: https://robolectric.org/javadoc/latest/index-all.html

Sets up a content provider for testing.

```APIDOC
## setupContentProvider(Class<T>)

### Description
Sets up a content provider for testing.

### Method
Static method in class `org.robolectric.Robolectric`

### Parameters
- **providerClass** (Class<T>) - Required - The content provider class to set up.
```

--------------------------------

### stopSelfResult(int id)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowService.html

Stops the service if the start ID matches the most recent start.

```APIDOC
## stopSelfResult(int id)

### Description
Stops the service if the start ID matches the most recent start.

### Method
`protected boolean stopSelfResult(int id)`

### Parameters
- **id** (int) - The start ID.

### Returns
- **boolean** - True if the service was stopped, false otherwise.
```

--------------------------------

### startShortcut(ShortcutInfo, Rect, Bundle) - ShadowLauncherApps

Source: https://robolectric.org/javadoc/latest/index-all.html

Method in class org.robolectric.shadows.ShadowLauncherApps. Starts a shortcut.

```APIDOC
## startShortcut(ShortcutInfo, Rect, Bundle)

### Description
Method in class org.robolectric.shadows.ShadowLauncherApps. Starts a shortcut.

### Method
startShortcut

### Signature
`public void startShortcut(ShortcutInfo shortcut, Rect sourceBounds, Bundle opts)`

### Parameters
- **shortcut** (ShortcutInfo) - Required - The shortcut info.
- **sourceBounds** (Rect) - Required - The source bounds.
- **opts** (Bundle) - Required - The options bundle.

```

--------------------------------

### start() - Method in class org.robolectric.shadows.ShadowNativeAnimatedVectorDrawable

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the native animated vector drawable shadow.

```APIDOC
## start() - Method in ShadowNativeAnimatedVectorDrawable

### Description
Starts the native animated vector drawable shadow.
```

--------------------------------

### startActivity(Context, Intent, Bundle) - Method in class org.robolectric.shadows.ShadowAppTask

Source: https://robolectric.org/javadoc/latest/index-all.html

Starts the activity using given context.

```APIDOC
## startActivity(Context, Intent, Bundle) - Method in ShadowAppTask

### Description
Starts the activity using given context.
```

--------------------------------

### ActivityController.start()

Source: https://robolectric.org/javadoc/latest/org/robolectric/android/controller/ActivityController.html

Starts the activity, mimicking the system lifecycle event.

```APIDOC
## ActivityController<T> start

### Description
Starts the activity.

### Method
`public ActivityController<T> start()`

### Returns
This controller instance.
```

--------------------------------

### installPackage(Uri, Object, int, String)

Source: https://robolectric.org/javadoc/latest/index-all.html

Method in class org.robolectric.shadows.ShadowApplicationPackageManager.

```APIDOC
## installPackage(Uri, Object, int, String)

### Description
Method in class org.robolectric.shadows.ShadowApplicationPackageManager.

### Method
installPackage(Uri, Object, int, String)

### Parameters
- **Uri** - The package URI.
- **Object** - The observer.
- **int** - The flags.
- **String** - The installer package name.
```

--------------------------------

### start()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowCountDownTimer.html

Starts the countdown timer. This method is called by the shadow to initiate the timer's operation.

```APIDOC
## start()

### Description
Starts the countdown timer. This method is called by the shadow to initiate the timer's operation.

### Method
start

### Signature
`protected CountDownTimer start()`

### Returns
- **CountDownTimer** - The started timer instance.
```

--------------------------------

### startPreview()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowCamera.html

Shadow implementation of Camera.startPreview() to start the preview.

```APIDOC
## startPreview()

### Description
Shadow implementation of Camera.startPreview() to start the preview.

### Method
Instance method

### Signature
`@Implementation protected void startPreview()`
```

--------------------------------

### setCanRequestPackageInstalls(boolean) - ShadowPackageManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Sets if the PackageManager is allowed to request package installs through package installer.

```APIDOC
## setCanRequestPackageInstalls(boolean)

### Description
Sets if the `PackageManager` is allowed to request package installs through package installer.

### Method
setCanRequestPackageInstalls

### Parameters
- **canRequestPackageInstalls** (boolean) - Required - Whether package installs can be requested.

```

--------------------------------

### Build service and content provider in Kotlin

Source: https://robolectric.org/upgrade_to_version_3

Kotlin equivalent of the Java example, using class references with ::class.

```kotlin
Robolectric.buildService(MyService::class).create().get()
Robolectric.setupContentProvider(MyContentProvider::class)
```

--------------------------------

### startLeScan (callback)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowBluetoothAdapter.html

Starts a Bluetooth LE scan with a callback. Returns true if scan started successfully.

```APIDOC
## startLeScan (callback)

### Description
Starts a Bluetooth LE scan with a callback. Returns true if scan started successfully.

### Method
protected boolean startLeScan(BluetoothAdapter.LeScanCallback callback)

### Parameters
- **callback** (BluetoothAdapter.LeScanCallback) - Required - The callback to receive scan results.

### Returns
- **boolean** - true if scan started successfully, false otherwise.
```

--------------------------------

### installExistingPackage(String)

Source: https://robolectric.org/javadoc/latest/index-all.html

Method in class org.robolectric.shadows.ShadowApplicationPackageManager.

```APIDOC
## installExistingPackage(String)

### Description
Method in class org.robolectric.shadows.ShadowApplicationPackageManager.

### Method
installExistingPackage(String)

### Parameters
- **String** - The package name.
```

--------------------------------

### Debug logging output example

Source: https://robolectric.org/getting-started

Example output when debug logging is enabled, showing resource loading messages.

```text
Loading resources for 'com.foo' from build/unpacked-libraries/library1...
```

--------------------------------

### startActivity(Intent, UserHandle, Activity) - Implementation

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowCrossProfileApps.html

Simulates starting the activity specified in the specified profile, performing the same security checks done by the real CrossProfileApps.

```APIDOC
## startActivity(Intent, UserHandle, Activity)

### Description
Simulates starting the activity specified in the specified profile, performing the same security checks done by the real `CrossProfileApps`. The most recent main activity started can be queried by `peekNextStartedActivity()`.

### Method
`@Implementation(minSdk=30) protected void startActivity(Intent intent, UserHandle targetUser, @Nullable Activity activity)`

### Parameters
- **intent** (Intent) - The intent to start.
- **targetUser** (UserHandle) - The target user profile.
- **activity** (Activity) - The activity from which the start is initiated.
```

--------------------------------

### startActivity(Intent, UserHandle, Activity, Bundle) - Method in class org.robolectric.shadows.ShadowCrossProfileApps

Source: https://robolectric.org/javadoc/latest/index-all.html

Simulates starting the activity specified in the specified profile, performing the same security checks done by the real `CrossProfileApps`.

```APIDOC
## startActivity(Intent, UserHandle, Activity, Bundle) - Method in ShadowCrossProfileApps

### Description
Simulates starting the activity specified in the specified profile, performing the same security checks done by the real `CrossProfileApps`.
```

--------------------------------

### build()

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/AudioDeviceInfoBuilder.html

Builds the AudioDeviceInfo instance with the configured settings.

```APIDOC
## build()

### Description
Builds the AudioDeviceInfo instance with the configured settings.

### Method
build

### Signature
public AudioDeviceInfo build()

### Returns
- **AudioDeviceInfo** - The built AudioDeviceInfo instance.
```

--------------------------------

### @Config annotation example (Kotlin)

Source: https://robolectric.org/configuring

Kotlin version of the @Config annotation example, using Kotlin syntax for arrays and class references.

```kotlin
@Config(
  sdk = Build.VERSION_CODES.TIRAMISU,
  shadows = [ShadowFoo::class, ShadowBar::class]
)
class SandwichTest

```

--------------------------------

### startLeScan (serviceUuids, callback)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowBluetoothAdapter.html

Starts a Bluetooth LE scan with specific service UUIDs and a callback. Returns true if scan started successfully.

```APIDOC
## startLeScan (serviceUuids, callback)

### Description
Starts a Bluetooth LE scan with specific service UUIDs and a callback. Returns true if scan started successfully.

### Method
protected boolean startLeScan(UUID[] serviceUuids, BluetoothAdapter.LeScanCallback callback)

### Parameters
- **serviceUuids** (UUID[]) - Required - Array of service UUIDs to filter the scan.
- **callback** (BluetoothAdapter.LeScanCallback) - Required - The callback to receive scan results.

### Returns
- **boolean** - true if scan started successfully, false otherwise.
```

--------------------------------

### prepare(Context) - ShadowVpnService

Source: https://robolectric.org/javadoc/latest/index-all.html

Static method in class org.robolectric.shadows.ShadowVpnService.

```APIDOC
## prepare(Context)

### Description
Static method in class org.robolectric.shadows.ShadowVpnService.

### Method
prepare

### Class
org.robolectric.shadows.ShadowVpnService

### Parameters
- **context** (Context) - Required - The context.

### Returns
No return value documented.
```

--------------------------------

### get()

Source: https://robolectric.org/javadoc/latest/org/robolectric/util/PerfStatsCollector.ThrowingSupplier.html

The get() method is the sole abstract method of the ThrowingSupplier interface. It returns a value of type T and may throw an exception of type F.

```APIDOC
## get()

### Description
Retrieves a result from this supplier, potentially throwing an exception of type F.

### Method
`T get() throws F`

### Parameters
None.

### Returns
- **T** - The result produced by this supplier.

### Throws
- **F** - If the supplier fails to produce a result.
```

--------------------------------

### startMainActivity(ComponentName, UserHandle) - Implementation

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowCrossProfileApps.html

Simulates starting the main activity specified in the specified profile, performing the same security checks done by the real CrossProfileApps.

```APIDOC
## startMainActivity(ComponentName, UserHandle)

### Description
Simulates starting the main activity specified in the specified profile, performing the same security checks done by the real `CrossProfileApps`. The most recent main activity started can be queried by `peekNextStartedActivity()`.

### Method
`@Implementation protected void startMainActivity(ComponentName componentName, UserHandle targetUser)`

### Parameters
- **componentName** (ComponentName) - The component name of the main activity.
- **targetUser** (UserHandle) - The target user profile.
```

--------------------------------

### setupIntentService(Class<T>) - Static method in class org.robolectric.Robolectric

Source: https://robolectric.org/javadoc/latest/index-all.html

Sets up an intent service for testing.

```APIDOC
## setupIntentService(Class<T>)

### Description
Sets up an intent service for testing.

### Method
Static method in class `org.robolectric.Robolectric`

### Parameters
- **serviceClass** (Class<T>) - Required - The intent service class to set up.
```

--------------------------------

### Cumulative qualifiers example in Kotlin

Source: https://robolectric.org/device-configuration

Kotlin version of the cumulative qualifiers example. Demonstrates the same overlay behavior with the '+' prefix in @Config qualifiers.

```kotlin
@Config(qualifiers = "xlarge-port")
class MyTest {
  @Test
  fun testItWithXlargePort() {
    // Config is "xlarge-port"
  }

  @Test
  @Config(qualifiers = "+land")
  fun testItWithXlargeLand() {
    // Config is "xlarge-land"
  }

  @Test
  @Config(qualifiers = "land")
  fun testItWithLand() {
    // Config is "normal-land"
  }
}

```

--------------------------------

### main(String[] args)

Source: https://robolectric.org/javadoc/latest/org/robolectric/simulator/SimulatorMain.html

The main entry point for the Robolectric Simulator. This static method can be called to start the simulator with the given command-line arguments.

```APIDOC
## main(String[] args)

### Description
Starts the Robolectric Simulator. This is the main entry point for the simulator application.

### Method
static void

### Signature
public static void main(String[] args)

### Parameters
- **args** (String[]) - Required - Command-line arguments for the simulator.

### Return Value
void

### Usage Example
```java
SimulatorMain.main(new String[] {"arg1", "arg2"});
```
```

--------------------------------

### startActivity(Intent, UserHandle, Activity) - Method in class org.robolectric.shadows.ShadowCrossProfileApps

Source: https://robolectric.org/javadoc/latest/index-all.html

Simulates starting the activity specified in the specified profile, performing the same security checks done by the real `CrossProfileApps`.

```APIDOC
## startActivity(Intent, UserHandle, Activity) - Method in ShadowCrossProfileApps

### Description
Simulates starting the activity specified in the specified profile, performing the same security checks done by the real `CrossProfileApps`.
```

--------------------------------

### startActivity(Intent, UserHandle, Activity, Bundle)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowCrossProfileApps.html

Simulates starting the activity specified in the specified profile, performing the same security checks done by the real CrossProfileApps.

```APIDOC
## startActivity(Intent, UserHandle, Activity, Bundle)

### Description
Simulates starting the activity specified in the specified profile, performing the same security checks done by the real `CrossProfileApps`.

### Method
`protected void startActivity(Intent intent, UserHandle targetUser, Activity activity, Bundle options)`

### Parameters
- **intent** (Intent) - The intent to start.
- **targetUser** (UserHandle) - The target user profile.
- **activity** (Activity) - The activity from which the start is initiated.
- **options** (Bundle) - Additional options for the activity start.

### Notes
- The most recent main activity started can be queried by `peekNextStartedActivity()`.
```

--------------------------------

### verifyPendingInstall(int id, int verificationCode)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowApplicationPackageManager.html

Verifies a pending install with a verification code. This method is protected and likely used internally by the shadow to simulate install verification.

```APIDOC
## verifyPendingInstall(int id, int verificationCode)

### Description
Verifies a pending install with a verification code.

### Method
verifyPendingInstall

### Parameters
- **id** (int) - Required - The ID of the pending install.
- **verificationCode** (int) - Required - The verification code.

### Return Type
protected void
```

--------------------------------

### startProvisionedVpnProfile() - ShadowVpnManager

Source: https://robolectric.org/javadoc/latest/index-all.html

Method in class org.robolectric.shadows.ShadowVpnManager. Starts a provisioned VPN profile.

```APIDOC
## startProvisionedVpnProfile()

### Description
Method in class org.robolectric.shadows.ShadowVpnManager. Starts a provisioned VPN profile.

### Method
startProvisionedVpnProfile

### Signature
`public void startProvisionedVpnProfile()`

```

--------------------------------

### setInstallerPackageName(String targetPackage, String installerPackageName)

Source: https://robolectric.org/javadoc/latest/org/robolectric/shadows/ShadowApplicationPackageManager.html

Sets the installer package name for a target package. This method is protected and likely used internally by the shadow to simulate setting the installer.

```APIDOC
## setInstallerPackageName(String targetPackage, String installerPackageName)

### Description
Sets the installer package name for a target package.

### Method
setInstallerPackageName

### Parameters
- **targetPackage** (String) - Required - The target package.
- **installerPackageName** (String) - Required - The installer package name.

### Return Type
protected String[]
```

--------------------------------

### ShadowDisplayManager example in Kotlin

Source: https://robolectric.org/writing-a-test

Shows how to use a static shadow class to simulate a new display being plugged in.

```kotlin
// Simulate a new display being plugged into the device
ShadowDisplayManager.addDisplay("xlarge-port")
```

--------------------------------

### setupIntentService(Class<T> serviceClass)

Source: https://robolectric.org/javadoc/latest/org/robolectric/Robolectric.html

Sets up an IntentService of the given class and returns its reference. The service is created and its lifecycle is started.

```APIDOC
## setupIntentService(Class<T> serviceClass)

### Description
Sets up an IntentService of the given class and returns its reference. The service is created and its lifecycle is started.

### Method
setupIntentService

### Signature
`public static <T extends IntentService> T setupIntentService(Class<T> serviceClass)`

### Parameters
- **serviceClass** (Class<T>) - Required - The class of the IntentService to set up.

### Returns
- **T** - The IntentService instance.

```
Tokens:
Raw