CloudMediaProviderContract.Capabilities.Builder
public
static
final
class
CloudMediaProviderContract.Capabilities.Builder
extends Object
java.lang.Object | |
↳ | android.provider.CloudMediaProviderContract.Capabilities.Builder |
Builder for a CloudMediaProviderContract.Capabilities
object.
See also:
Summary
Public constructors | |
---|---|
Builder()
|
Public methods | |
---|---|
CloudMediaProviderContract.Capabilities
|
build()
Create a new |
CloudMediaProviderContract.Capabilities.Builder
|
setAlbumsAsCategoryEnabled(boolean enabled)
Set true if the CloudMediaProvider will return user albums as a grouped category. |
CloudMediaProviderContract.Capabilities.Builder
|
setMediaCategoriesEnabled(boolean enabled)
The MediaCategories capability informs that category related APIs are supported and can be invoked on this provider. |
CloudMediaProviderContract.Capabilities.Builder
|
setSearchEnabled(boolean enabled)
The SearchEnabled capability informs that search related APIs are supported and can be invoked on this provider. |
Inherited methods | |
---|---|
Public constructors
Public methods
build
public CloudMediaProviderContract.Capabilities build ()
Create a new CloudMediaProviderContract.Capabilities
object with the
current builder's Capabilities.
Returns | |
---|---|
CloudMediaProviderContract.Capabilities |
This value cannot be null . |
setAlbumsAsCategoryEnabled
public CloudMediaProviderContract.Capabilities.Builder setAlbumsAsCategoryEnabled (boolean enabled)
Set true 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 CloudMediaProviderContract.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.
Parameters | |
---|---|
enabled |
boolean : true if this capability is supported, the default value is false. |
Returns | |
---|---|
CloudMediaProviderContract.Capabilities.Builder |
This value cannot be null . |
setMediaCategoriesEnabled
public CloudMediaProviderContract.Capabilities.Builder setMediaCategoriesEnabled (boolean enabled)
The MediaCategories capability informs that category related APIs are supported and can be invoked on this provider.
Parameters | |
---|---|
enabled |
boolean : true if this capability is supported, the default value is false. |
Returns | |
---|---|
CloudMediaProviderContract.Capabilities.Builder |
This value cannot be null . |
setSearchEnabled
public CloudMediaProviderContract.Capabilities.Builder setSearchEnabled (boolean enabled)
The SearchEnabled capability informs that search related APIs are supported and can be invoked on this provider.
Parameters | |
---|---|
enabled |
boolean : true if this capability is supported, the default value is false. |
Returns | |
---|---|
CloudMediaProviderContract.Capabilities.Builder |
This value cannot be null . |