Skip to content

Most visited

Recently visited

navigation
Added in API level 19

DocumentsContract.Root

public static final class DocumentsContract.Root
extends Object

java.lang.Object
   ↳ android.provider.DocumentsContract.Root


Constants related to a root of documents, including Cursor column names and flags. A root is the start of a tree of documents, such as a physical storage device, or an account. Each root starts at the directory referenced by COLUMN_DOCUMENT_ID, which can recursively contain both documents and directories.

All columns are read-only to client applications.

Summary

Constants

String COLUMN_AVAILABLE_BYTES

Number of bytes available in this root.

String COLUMN_CAPACITY_BYTES

Capacity of a root in bytes.

String COLUMN_DOCUMENT_ID

Document which is a directory that represents the top directory of this root.

String COLUMN_FLAGS

Flags that apply to a root.

String COLUMN_ICON

Icon resource ID for a root.

String COLUMN_MIME_TYPES

MIME types supported by this root.

String COLUMN_ROOT_ID

Unique ID of a root.

String COLUMN_SUMMARY

Summary for this root, which may be shown to a user.

String COLUMN_TITLE

Title for a root, which will be shown to a user.

int FLAG_LOCAL_ONLY

Flag indicating that this root offers content that is strictly local on the device.

int FLAG_SUPPORTS_CREATE

Flag indicating that at least one directory under this root supports creating content.

int FLAG_SUPPORTS_IS_CHILD

Flag indicating that this root supports testing parent child relationships.

int FLAG_SUPPORTS_RECENTS

Flag indicating that this root can be queried to provide recently modified documents.

int FLAG_SUPPORTS_SEARCH

Flag indicating that this root supports search.

Inherited methods

From class java.lang.Object

Constants

COLUMN_AVAILABLE_BYTES

Added in API level 19
String COLUMN_AVAILABLE_BYTES

Number of bytes available in this root. This column is optional, and may be null if unknown or unbounded.

Type: INTEGER (long)

Constant Value: "available_bytes"

COLUMN_CAPACITY_BYTES

Added in API level 24
String COLUMN_CAPACITY_BYTES

Capacity of a root in bytes. This column is optional, and may be null if unknown or unbounded.

Type: INTEGER (long)

Constant Value: "capacity_bytes"

COLUMN_DOCUMENT_ID

Added in API level 19
String COLUMN_DOCUMENT_ID

Document which is a directory that represents the top directory of this root. This column is required.

Type: STRING

See also:

Constant Value: "document_id"

COLUMN_FLAGS

Added in API level 19
String COLUMN_FLAGS

Flags that apply to a root. This column is required.

Type: INTEGER (int)

See also:

Constant Value: "flags"

COLUMN_ICON

Added in API level 19
String COLUMN_ICON

Icon resource ID for a root. This column is required.

Type: INTEGER (int)

Constant Value: "icon"

COLUMN_MIME_TYPES

Added in API level 19
String COLUMN_MIME_TYPES

MIME types supported by this root. This column is optional, and if null the root is assumed to support all MIME types. Multiple MIME types can be separated by a newline. For example, a root supporting audio might return "audio/*\napplication/x-flac".

Type: STRING

Constant Value: "mime_types"

COLUMN_ROOT_ID

Added in API level 19
String COLUMN_ROOT_ID

Unique ID of a root. This ID is both provided by and interpreted by a DocumentsProvider, and should be treated as an opaque value by client applications. This column is required.

Type: STRING

Constant Value: "root_id"

COLUMN_SUMMARY

Added in API level 19
String COLUMN_SUMMARY

Summary for this root, which may be shown to a user. This column is optional, and may be null. For a single storage service surfacing multiple accounts as different roots, this summary should be the name of the account.

Type: STRING

Constant Value: "summary"

COLUMN_TITLE

Added in API level 19
String COLUMN_TITLE

Title for a root, which will be shown to a user. This column is required. For a single storage service surfacing multiple accounts as different roots, this title should be the name of the service.

Type: STRING

Constant Value: "title"

FLAG_LOCAL_ONLY

Added in API level 19
int FLAG_LOCAL_ONLY

Flag indicating that this root offers content that is strictly local on the device. That is, no network requests are made for the content.

See also:

Constant Value: 2 (0x00000002)

FLAG_SUPPORTS_CREATE

Added in API level 19
int FLAG_SUPPORTS_CREATE

Flag indicating that at least one directory under this root supports creating content. Roots with this flag will be shown when an application interacts with ACTION_CREATE_DOCUMENT.

See also:

Constant Value: 1 (0x00000001)

FLAG_SUPPORTS_IS_CHILD

Added in API level 21
int FLAG_SUPPORTS_IS_CHILD

Flag indicating that this root supports testing parent child relationships.

See also:

Constant Value: 16 (0x00000010)

FLAG_SUPPORTS_RECENTS

Added in API level 19
int FLAG_SUPPORTS_RECENTS

Flag indicating that this root can be queried to provide recently modified documents.

See also:

Constant Value: 4 (0x00000004)

FLAG_SUPPORTS_SEARCH

Added in API level 19
int FLAG_SUPPORTS_SEARCH

Flag indicating that this root supports search.

See also:

Constant Value: 8 (0x00000008)

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.