Added in API level 36
Also in R Extensions 16

Capabilities

Kotlin |Java

class Capabilities : Parcelable

kotlin.Any
↳	android.provider.CloudMediaProviderContract.Capabilities

Information about what capabilities a CloudMediaProvider can support. This will be used by the system to inform which APIs should be expected to return data. This object is returned from CloudMediaProvider.onGetCapabilities. This object enumerates which capabilities are provided by the CloudMediaProvider implementation that supplied this object.

Summary

Nested classes
	`Builder` Builder for a `CloudMediaProviderContract.Capabilities` object.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()` Implemented for `Parcelable`
Boolean	`isAlbumsAsCategoryEnabled()` If the CloudMediaProvider will return user albums as a grouped category.
Boolean	`isMediaCategoriesEnabled()` If the CloudMediaProvider supports MediaCategories.
Boolean	`isSearchEnabled()` If the CloudMediaProvider supports Search functionality.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Implemented for `Parcelable`

Properties
static Parcelable.Creator<CloudMediaProviderContract.Capabilities!>	`CREATOR` Implemented for `Parcelable`

Public methods

describeContents

Added in API level 36

fun describeContents(): Int

Implemented for Parcelable

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

isAlbumsAsCategoryEnabled

Added in API level 36.1
Also in R Extensions 19

fun isAlbumsAsCategoryEnabled(): Boolean

If the CloudMediaProvider will return user albums as a grouped category. When this capability is enabled, CloudMediaProvider.onQueryAlbums will no longer be called to sync the users albums, and it is expected that a category with the type MEDIA_CATEGORY_TYPE_USER_ALBUMS will be provided in the CloudMediaProvider.onQueryMediaCategories for providing the user's custom albums. If no such category is returned, then there will be no data for user custom albums. NOTE: This capability requires the Capabilities.isMediaCategoriesEnabled capability to also be enabled for the CloudMediaProvider. If it is not, this Capability has no effect and will be ignored.

Return
`Boolean`	true if albums will be returned as a MediaCategory.

See Also

isMediaCategoriesEnabled

Added in API level 36
Also in R Extensions 16

fun isMediaCategoriesEnabled(): Boolean

If the CloudMediaProvider supports MediaCategories. In order for MediaCategories to be enabled the CloudMediaProvider needs to implement the following APIs:

Return
`Boolean`	true if media categories are enabled for this CloudMediaProvider.

See Also

isSearchEnabled

Added in API level 36
Also in R Extensions 16

fun isSearchEnabled(): Boolean

If the CloudMediaProvider supports Search functionality. In order for search to be enabled the CloudMediaProvider needs to implement the following APIs:

Return
`Boolean`	true if search is enabled for this CloudMediaProvider.

See Also

android.provider.CloudMediaProvider#onQuerySearchSuggestions

writeToParcel

Added in API level 36

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Implemented for Parcelable

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 36
Also in R Extensions 16

static val CREATOR: Parcelable.Creator<CloudMediaProviderContract.Capabilities!>

Implemented for Parcelable