Package org.robolectric.shadows

Class ShadowBugreportManager

java.lang.Object

org.robolectric.shadows.ShadowBugreportManager

@Implements(value=android.os.BugreportManager.class,
            minSdk=29,
            isInAndroidSdk=false)
public class ShadowBugreportManager
extends Object

Implementation of BugreportManager.

This class is not available in the public Android SDK, but it is available for system apps.

Constructor Summary

Constructors

Constructor	Description
ShadowBugreportManager()

Method Summary

Modifier and Type	Method	Description
protected void	cancelBugreport()	Cancels bugreport in progress and executes BugreportManager.BugreportCallback.onError(int).
void	executeOnError(int errorCode)	Executes BugreportManager.BugreportCallback.onError(int) on the provided Executor.
void	executeOnFinished()	Executes BugreportManager.BugreportCallback.onFinished() on the provided Executor.
void	executeOnFinished(String bugreportFile)	Executes BugreportManager.BugreportCallback.onFinished(String) on the provided Executor.
void	executeOnProgress(float progress)	Executes BugreportManager.BugreportCallback.onProgress(float) on the provided Executor.
ParcelFileDescriptor	getBugreportFd()	Returns the bug report file descriptor if set with startBugreport or retrieveBugreport, else null.
ParcelFileDescriptor	getScreenshotFd()	Returns the screenshot file descriptor if set with startBugreport, else null.
CharSequence	getShareDescription()	Returns the description of the bugreport if set with requestBugreport, else null.
CharSequence	getShareTitle()	Returns the title of the bugreport if set with requestBugreport, else null.
boolean	isBugreportInProgress()
protected void	requestBugreport(BugreportParams params, CharSequence shareTitle, CharSequence shareDescription)	Normally requests the platform/system to take a bugreport and make the final bugreport available to the user.
protected void	retrieveBugreport(String bugreportFile, ParcelFileDescriptor bugreportFd, Executor executor, BugreportManager.BugreportCallback callback)
void	setHasPermission(boolean hasPermission)	Simulates if the calling process has the required permissions to call BugreportManager methods.
protected void	startBugreport(ParcelFileDescriptor bugreportFd, ParcelFileDescriptor screenshotFd, BugreportParams params, Executor executor, BugreportManager.BugreportCallback callback)	Starts a bugreport with which can execute callback methods on the provided executor.
boolean	wasBugreportRequested()	Returns true if requestBugreport(android.os.BugreportParams, java.lang.CharSequence, java.lang.CharSequence) was called.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShadowBugreportManager

public ShadowBugreportManager()

Method Details

startBugreport

@Implementation
protected void startBugreport(ParcelFileDescriptor bugreportFd,
 ParcelFileDescriptor screenshotFd,
 BugreportParams params,
 Executor executor,
 BugreportManager.BugreportCallback callback)

Starts a bugreport with which can execute callback methods on the provided executor.

If bugreport already in progress, BugreportManager.BugreportCallback.onError(int) will be executed.

requestBugreport

@Implementation(minSdk=30)
protected void requestBugreport(BugreportParams params,
 CharSequence shareTitle,
 CharSequence shareDescription)

Normally requests the platform/system to take a bugreport and make the final bugreport available to the user.

This implementation just sets a boolean recording that the method was invoked, and the share title and description.

retrieveBugreport

@Implementation(minSdk=34)
protected void retrieveBugreport(String bugreportFile,
 ParcelFileDescriptor bugreportFd,
 Executor executor,
 BugreportManager.BugreportCallback callback)

cancelBugreport

@Implementation
protected void cancelBugreport()

Cancels bugreport in progress and executes BugreportManager.BugreportCallback.onError(int).

executeOnProgress

public void executeOnProgress(float progress)

Executes BugreportManager.BugreportCallback.onProgress(float) on the provided Executor.

executeOnError

public void executeOnError(int errorCode)

Executes BugreportManager.BugreportCallback.onError(int) on the provided Executor.

executeOnFinished

public void executeOnFinished()

Executes BugreportManager.BugreportCallback.onFinished() on the provided Executor.

executeOnFinished

public void executeOnFinished(String bugreportFile)

Executes BugreportManager.BugreportCallback.onFinished(String) on the provided Executor.

isBugreportInProgress

public boolean isBugreportInProgress()

wasBugreportRequested

public boolean wasBugreportRequested()

Returns true if requestBugreport(android.os.BugreportParams, java.lang.CharSequence, java.lang.CharSequence) was called.

setHasPermission

public void setHasPermission(boolean hasPermission)

Simulates if the calling process has the required permissions to call BugreportManager methods.

If hasPermission is false, startBugreport(android.os.ParcelFileDescriptor, android.os.ParcelFileDescriptor, android.os.BugreportParams, java.util.concurrent.Executor, android.os.BugreportManager.BugreportCallback) and cancelBugreport() will throw SecurityException.

getShareTitle

public CharSequence getShareTitle()

Returns the title of the bugreport if set with requestBugreport, else null.

getShareDescription

public CharSequence getShareDescription()

Returns the description of the bugreport if set with requestBugreport, else null.

getBugreportFd

public ParcelFileDescriptor getBugreportFd()

Returns the bug report file descriptor if set with startBugreport or retrieveBugreport, else null.

getScreenshotFd

public ParcelFileDescriptor getScreenshotFd()

Returns the screenshot file descriptor if set with startBugreport, else null.