Added in API level 29

Summary: Constants | Methods | Inherited Methods

StatusBarManager

---

Kotlin |Java

public class StatusBarManager
extends Object

java.lang.Object
↳	android.app.StatusBarManager

---

Allows an app to control the status bar.

Summary

Constants
int	TILE_ADD_REQUEST_ERROR_APP_NOT_IN_FOREGROUND Indicates that the requesting application is not in the foreground.
int	TILE_ADD_REQUEST_ERROR_BAD_COMPONENT Indicates that the component does not match an enabled exported TileService for the current user.
int	TILE_ADD_REQUEST_ERROR_MISMATCHED_PACKAGE Indicates that this package does not match that of the TileService.
int	TILE_ADD_REQUEST_ERROR_NOT_CURRENT_USER Indicates that the user is not the current user.
int	TILE_ADD_REQUEST_ERROR_NO_STATUS_BAR_SERVICE The request could not be processed because no fulfilling service was found.
int	TILE_ADD_REQUEST_ERROR_REQUEST_IN_PROGRESS Indicates that there's a request in progress for this package.
int	TILE_ADD_REQUEST_RESULT_TILE_ADDED Response indicating that the tile was added.
int	TILE_ADD_REQUEST_RESULT_TILE_ALREADY_ADDED Response indicating that the tile was already added and the user was not prompted.
int	TILE_ADD_REQUEST_RESULT_TILE_NOT_ADDED Response indicating that the tile was not added.

Public methods
boolean	canLaunchCaptureContentActivityForNote(Activity activity) Checks whether the supplied activity can Activity#startActivityForResult(Intent, int) a system activity that captures content on the screen to take a screenshot.
void	requestAddTileService(ComponentName tileServiceComponentName, CharSequence tileLabel, Icon icon, Executor resultExecutor, Consumer<Integer> resultCallback) Request to the user to add a TileService to the set of current QS tiles.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

TILE_ADD_REQUEST_ERROR_APP_NOT_IN_FOREGROUND

Added in API level 33

public static final int TILE_ADD_REQUEST_ERROR_APP_NOT_IN_FOREGROUND

Indicates that the requesting application is not in the foreground.

Constant Value: 1004 (0x000003ec)

TILE_ADD_REQUEST_ERROR_BAD_COMPONENT

Added in API level 33

public static final int TILE_ADD_REQUEST_ERROR_BAD_COMPONENT

Indicates that the component does not match an enabled exported TileService for the current user.

Constant Value: 1002 (0x000003ea)

TILE_ADD_REQUEST_ERROR_MISMATCHED_PACKAGE

Added in API level 33

public static final int TILE_ADD_REQUEST_ERROR_MISMATCHED_PACKAGE

Indicates that this package does not match that of the TileService.

Constant Value: 1000 (0x000003e8)

TILE_ADD_REQUEST_ERROR_NOT_CURRENT_USER

Added in API level 33

public static final int TILE_ADD_REQUEST_ERROR_NOT_CURRENT_USER

Indicates that the user is not the current user.

Constant Value: 1003 (0x000003eb)

TILE_ADD_REQUEST_ERROR_NO_STATUS_BAR_SERVICE

Added in API level 33

public static final int TILE_ADD_REQUEST_ERROR_NO_STATUS_BAR_SERVICE

The request could not be processed because no fulfilling service was found. This could be a temporary issue (for example, SystemUI has crashed).

Constant Value: 1005 (0x000003ed)

TILE_ADD_REQUEST_ERROR_REQUEST_IN_PROGRESS

Added in API level 33

public static final int TILE_ADD_REQUEST_ERROR_REQUEST_IN_PROGRESS

Indicates that there's a request in progress for this package.

Constant Value: 1001 (0x000003e9)

TILE_ADD_REQUEST_RESULT_TILE_ADDED

Added in API level 33

public static final int TILE_ADD_REQUEST_RESULT_TILE_ADDED

Response indicating that the tile was added.

Constant Value: 2 (0x00000002)

TILE_ADD_REQUEST_RESULT_TILE_ALREADY_ADDED

Added in API level 33

public static final int TILE_ADD_REQUEST_RESULT_TILE_ALREADY_ADDED

Response indicating that the tile was already added and the user was not prompted.

Constant Value: 1 (0x00000001)

TILE_ADD_REQUEST_RESULT_TILE_NOT_ADDED

Added in API level 33

public static final int TILE_ADD_REQUEST_RESULT_TILE_NOT_ADDED

Response indicating that the tile was not added.

Constant Value: 0 (0x00000000)

Public methods

canLaunchCaptureContentActivityForNote

Added in API level 34

public boolean canLaunchCaptureContentActivityForNote (Activity activity)

Checks whether the supplied activity can Activity#startActivityForResult(Intent, int) a system activity that captures content on the screen to take a screenshot.

Note: The result should not be cached.

The system activity displays an editing tool that allows user to edit the screenshot, save it on device, and return the edited screenshot as Uri to the calling activity. User interaction is required to return the edited screenshot to the calling activity.

When true, callers can use Activity#startActivityForResult(Intent, int) to start start the content capture activity using Intent#ACTION_LAUNCH_CAPTURE_CONTENT_ACTIVITY_FOR_NOTE.
Requires Manifest.permission.LAUNCH_CAPTURE_CONTENT_ACTIVITY_FOR_NOTE

Parameters
activity	Activity: Calling activity This value cannot be null.

Returns
boolean	true if the activity supports launching the capture content activity for note.

See also:

• Intent.ACTION_LAUNCH_CAPTURE_CONTENT_ACTIVITY_FOR_NOTE
• Manifest.permission.LAUNCH_CAPTURE_CONTENT_ACTIVITY_FOR_NOTE
• RoleManager.ROLE_NOTES

requestAddTileService

Added in API level 33

public void requestAddTileService (ComponentName tileServiceComponentName, 
                CharSequence tileLabel, 
                Icon icon, 
                Executor resultExecutor, 
                Consumer<Integer> resultCallback)

Request to the user to add a TileService to the set of current QS tiles.

Calling this will prompt the user to decide whether they want to add the shown TileService to their current tiles. The user can deny the request and the system can stop processing requests for a given ComponentName after a number of requests.

The request will show to the user information about the tile:

• Application name
• Label for the tile
• Icon for the tile

The user for which this will be added is determined from the Context used to retrieve this service, and must match the current user. The requesting application must be in the foreground (ActivityManager.RunningAppProcessInfo#IMPORTANCE_FOREGROUND and the TileService must be exported. Note: the system can choose to auto-deny a request if the user has denied that specific request (user, ComponentName) enough times before.

Parameters
tileServiceComponentName	ComponentName: ComponentName of the TileService for the request. This value cannot be null.
tileLabel	CharSequence: label of the tile to show to the user. This value cannot be null.
icon	Icon: icon to use in the tile shown to the user. This value cannot be null.
resultExecutor	Executor: an executor to run the callback on This value cannot be null.
resultCallback	Consumer: callback to indicate the result of the request. This value cannot be null.

See also:

• TileService