ContextCompat

const val RECEIVER_EXPORTED = 2: Int

Flag for registerReceiver: The receiver can receive broadcasts from other Apps. Has the same behavior as marking a statically registered receiver with "exported=true"

const val RECEIVER_NOT_EXPORTED = 4: Int

Flag for registerReceiver: The receiver cannot receive broadcasts from other Apps. Has the same behavior as marking a statically registered receiver with "exported=false"

const val RECEIVER_VISIBLE_TO_INSTANT_APPS = 1: Int

Flag for registerReceiver: The receiver can receive broadcasts from Instant Apps.

protected ContextCompat()

This class should not be instantiated, but the constructor must be visible for the class to be extended (ex. in ActivityCompat).

java-static fun checkSelfPermission(context: Context, permission: String): Int

Determine whether you have been granted a particular permission.

java-static fun createAttributionContext(context: Context, attributionTag: String?): Context

Return a new Context object for the current Context but attribute to a different tag. In complex apps attribution tagging can be used to distinguish between separate logical parts.

Compatibility behavior:

• API 30 and above, returns a new Context object with the specified attribution tag
• API 29 and earlier, returns the original context with no attribution tag

java-static fun createDeviceProtectedStorageContext(context: Context): Context?

Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.

On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both before and after the user has authenticated with their credentials (such as a lock pattern or PIN).

Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged.

If the underlying device does not have the ability to store device-protected and credential-protected data using different keys, then both storage areas will become available at the same time. They remain as two distinct storage locations on disk, and only the window of availability changes.

Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.

Prior to API 24 this method returns null, since device-protected storage is not available.

java-static fun getAttributionTag(context: Context): String?

Attribution can be used in complex apps to logically separate parts of the app. E.g. a blogging app might also have a instant messaging app built in. In this case two separate tags can for used each sub-feature.

Compatibility behavior:

• API 30 and above, returns the attribution tag or null
• API 29 and earlier, returns null

java-static fun getCodeCacheDir(context: Context): File

Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code. On devices running LOLLIPOP or later, the system will delete any files stored in this location both when your specific application is upgraded, and when the entire platform is upgraded.

This location is optimal for storing compiled or optimized code generated by your application at runtime.

Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.

java-static fun getColor(context: Context, id: @ColorRes Int): @ColorInt Int

Returns a color associated with a particular resource ID

Starting in M, the returned color will be styled for the specified Context's theme.

java-static fun getColorStateList(context: Context, id: @ColorRes Int): ColorStateList?

Returns a color state list associated with a particular resource ID.

Starting in M, the returned color state list will be styled for the specified Context's theme.

java-static fun getContextForLanguage(context: Context): Context

Gets the context which respects the per-app locales locale. This API is specifically for developers who set the per-app locales via setApplicationLocales, but who needs to use the context out of androidx.appcompat.app.AppCompatActivity scope.

The developers can override the returned context in Application's attachBaseContext, so that developers can get the localized string via application's context.

Compatibility behavior:

• API 17 and above, the locale in the context returned by this method will respect the the per-app locale.
• API 16 and earlier, this method directly return the Context

java-static fun getDataDir(context: Context): File?

Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored. Apps should not use this path directly; they should instead use getFilesDir, getCacheDir, getDir, or other storage APIs on Context.

The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.

No additional permissions are required for the calling app to read or write files under the returned path.

java-static fun getDisplayOrDefault(context: @DisplayContext Context): Display

Get the display this context is associated with or the default display as the fallback if the context is not associated with any Display.

Applications must use this method with Activity or a context associated with a Display via createDisplayContext or createWindowContext, or the reported Display instance is not reliable.

java-static fun getDrawable(context: Context, id: @DrawableRes Int): Drawable?

Returns a drawable object associated with a particular resource ID.

Starting in LOLLIPOP, the returned drawable will be styled for the specified Context's theme.

@ReplaceWith(expression = "context.getExternalCacheDirs()")
java-static fun getExternalCacheDirs(context: Context): Array<File!>

Returns absolute paths to application-specific directories on all external storage devices where the application can place cache files it owns. These files are internal to the application, and not typically visible to the user as media.

This is like getCacheDir in that these files will be deleted when the application is uninstalled, however there are some important differences:

• External files are not always available: they will disappear if the user mounts the external storage on a computer or removes it.
• There is no security enforced with these files.

External storage devices returned here are considered a permanent part of the device, including both emulated external storage and physical media slots, such as SD cards in a battery compartment. The returned paths do not include transient devices, such as USB flash drives.

An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs.

Starting in KITKAT, no permissions are required to write to the returned paths; they're always accessible to the calling app. Before then, WRITE_EXTERNAL_STORAGE is required to write. Write access outside of these paths on secondary external storage devices is not available. To request external storage access in a backwards compatible way, consider using android:maxSdkVersion like this:

<uses-permission
    android:name="android.permission.WRITE_EXTERNAL_STORAGE"
android:maxSdkVersion="18" />

The first path returned is the same as getExternalCacheDir. Returned paths may be null if a storage device is unavailable.

@ReplaceWith(expression = "context.getExternalFilesDirs(type)")
java-static fun getExternalFilesDirs(context: Context, type: String?): Array<File!>

Returns absolute paths to application-specific directories on all external storage devices where the application can place persistent files it owns. These files are internal to the application, and not typically visible to the user as media.

This is like getFilesDir in that these files will be deleted when the application is uninstalled, however there are some important differences:

• External files are not always available: they will disappear if the user mounts the external storage on a computer or removes it.
• There is no security enforced with these files.

External storage devices returned here are considered a permanent part of the device, including both emulated external storage and physical media slots, such as SD cards in a battery compartment. The returned paths do not include transient devices, such as USB flash drives.

An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs.

Starting in KITKAT, no permissions are required to write to the returned paths; they're always accessible to the calling app. Before then, WRITE_EXTERNAL_STORAGE is required to write. Write access outside of these paths on secondary external storage devices is not available. To request external storage access in a backwards compatible way, consider using android:maxSdkVersion like this:

<uses-permission
    android:name="android.permission.WRITE_EXTERNAL_STORAGE"
android:maxSdkVersion="18" />

The first path returned is the same as getExternalFilesDir. Returned paths may be null if a storage device is unavailable.

java-static fun getMainExecutor(context: Context): Executor

Return an Executor that will run enqueued tasks on the main thread associated with this context. This is the thread used to dispatch calls to application components (activities, services, etc).

java-static fun getNoBackupFilesDir(context: Context): File?

Returns the absolute path to the directory on the filesystem similar to getFilesDir. The difference is that files placed under this directory will be excluded from automatic backup to remote storage on devices running LOLLIPOP or later.

No permissions are required to read or write to the returned path, since this path is internal storage.

@ReplaceWith(expression = "context.getObbDirs()")
java-static fun getObbDirs(context: Context): Array<File!>

Returns absolute paths to application-specific directories on all external storage devices where the application's OBB files (if there are any) can be found. Note if the application does not have any OBB files, these directories may not exist.

This is like getFilesDir in that these files will be deleted when the application is uninstalled, however there are some important differences:

• External files are not always available: they will disappear if the user mounts the external storage on a computer or removes it.
• There is no security enforced with these files.

External storage devices returned here are considered a permanent part of the device, including both emulated external storage and physical media slots, such as SD cards in a battery compartment. The returned paths do not include transient devices, such as USB flash drives.

An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs.

Starting in KITKAT, no permissions are required to write to the returned paths; they're always accessible to the calling app. Before then, WRITE_EXTERNAL_STORAGE is required to write. Write access outside of these paths on secondary external storage devices is not available. To request external storage access in a backwards compatible way, consider using android:maxSdkVersion like this:

<uses-permission
    android:name="android.permission.WRITE_EXTERNAL_STORAGE"
android:maxSdkVersion="18" />

The first path returned is the same as getObbDir. Returned paths may be null if a storage device is unavailable.

java-static fun getString(context: Context, resId: Int): String

Gets the resource string that also respects the per-app locales. If developers set the per-app locales via setApplicationLocales, this API returns localized strings even if the context is not androidx.appcompat.app.AppCompatActivity.

Compatibility behavior:

• API 17 and above, this method return the localized string that respects per-app locales.
• API 16 and earlier, this method directly return the result of getString

java-static fun <T> getSystemService(context: Context, serviceClass: Class<T!>): T?

Return the handle to a system-level service by class.

java-static fun getSystemServiceName(context: Context, serviceClass: Class<Any!>): String?

Gets the name of the system-level service that is represented by the specified class.

java-static fun isDeviceProtectedStorage(context: Context): Boolean

Indicates if the storage APIs of this Context are backed by device-encrypted storage.

java-static fun registerReceiver(
    context: Context,
    receiver: BroadcastReceiver?,
    filter: IntentFilter,
    flags: Int
): Intent?

Register a broadcast receiver.

java-static fun registerReceiver(
    context: Context,
    receiver: BroadcastReceiver?,
    filter: IntentFilter,
    broadcastPermission: String?,
    scheduler: Handler?,
    flags: Int
): Intent?

Register a broadcast receiver.

java-static fun startActivities(context: Context, intents: Array<Intent!>): Boolean

Start a set of activities as a synthesized task stack, if able.

In API level 11 (Android 3.0/Honeycomb) the recommended conventions for app navigation using the back key changed. The back key's behavior is local to the current task and does not capture navigation across different tasks. Navigating across tasks and easily reaching the previous task is accomplished through the "recents" UI, accessible through the software-provided Recents key on the navigation or system bar. On devices with the older hardware button configuration the recents UI can be accessed with a long press on the Home key.

When crossing from one task stack to another post-Android 3.0, the application should synthesize a back stack/history for the new task so that the user may navigate out of the new task and back to the Launcher by repeated presses of the back key. Back key presses should not navigate across task stacks.

startActivities provides a mechanism for constructing a synthetic task stack of multiple activities. If the underlying API is not available on the system this method will return false.

java-static fun startActivities(context: Context, intents: Array<Intent!>, options: Bundle?): Boolean

Start a set of activities as a synthesized task stack, if able.

In API level 11 (Android 3.0/Honeycomb) the recommended conventions for app navigation using the back key changed. The back key's behavior is local to the current task and does not capture navigation across different tasks. Navigating across tasks and easily reaching the previous task is accomplished through the "recents" UI, accessible through the software-provided Recents key on the navigation or system bar. On devices with the older hardware button configuration the recents UI can be accessed with a long press on the Home key.

When crossing from one task stack to another post-Android 3.0, the application should synthesize a back stack/history for the new task so that the user may navigate out of the new task and back to the Launcher by repeated presses of the back key. Back key presses should not navigate across task stacks.

startActivities provides a mechanism for constructing a synthetic task stack of multiple activities. If the underlying API is not available on the system this method will return false.

@ReplaceWith(expression = "context.startActivity(intent, options)")
java-static fun startActivity(context: Context, intent: Intent, options: Bundle?): Unit

Start an activity with additional launch information, if able.

In Android 4.1+ additional options were introduced to allow for more control on activity launch animations. Applications can use this method along with ActivityOptionsCompat to use these animations when available. When run on versions of the platform where this feature does not exist the activity will be launched normally.

java-static fun startForegroundService(context: Context, intent: Intent): Unit

startForegroundService() was introduced in O, just call startService for before O.