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 Root#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_QUERY_ARGS

Query arguments 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_EMPTY

Flag indicating that this root is currently empty.

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_EJECT

Flag indicating that this root can be ejected.

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.

String MIME_TYPE_ITEM

MIME type for a root.

Inherited methods

Constants

COLUMN_AVAILABLE_BYTES

Added in API level 19
public static final 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
public static final 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
public static final String COLUMN_DOCUMENT_ID

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

Type: STRING

Constant Value: "document_id"

COLUMN_FLAGS

Added in API level 19
public static final String COLUMN_FLAGS

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

Type: INTEGER (int)

Constant Value: "flags"

COLUMN_ICON

Added in API level 19
public static final 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
public static final 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_QUERY_ARGS

Added in API level 29
public static final String COLUMN_QUERY_ARGS

Query arguments supported by this root. This column is optional and related to COLUMN_FLAGS and FLAG_SUPPORTS_SEARCH. If the flags include FLAG_SUPPORTS_SEARCH, and the column is null, the root is assumed to support DocumentsContract.QUERY_ARG_DISPLAY_NAME search of Document#COLUMN_DISPLAY_NAME. Multiple query arguments can be separated by a newline. For example, a root supporting DocumentsContract.QUERY_ARG_MIME_TYPES and DocumentsContract.QUERY_ARG_DISPLAY_NAME might return "android:query-arg-mime-types\nandroid:query-arg-display-name".

Type: STRING

Constant Value: "query_args"

COLUMN_ROOT_ID

Added in API level 19
public static final 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
public static final 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
public static final 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_EMPTY

Added in API level 29
public static final int FLAG_EMPTY

Flag indicating that this root is currently empty. This may be used to hide the root when opening documents, but the root will still be shown when creating documents and FLAG_SUPPORTS_CREATE is also set. If the value of this flag changes, such as when a root becomes non-empty, you must send a content changed notification for DocumentsContract#buildRootsUri(String).

Constant Value: 64 (0x00000040)

FLAG_LOCAL_ONLY

Added in API level 19
public static final 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.

Constant Value: 2 (0x00000002)

FLAG_SUPPORTS_CREATE

Added in API level 19
public static final 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 Intent#ACTION_CREATE_DOCUMENT.

See also:

Constant Value: 1 (0x00000001)

FLAG_SUPPORTS_EJECT

Added in API level 26
public static final int FLAG_SUPPORTS_EJECT

Flag indicating that this root can be ejected.

Constant Value: 32 (0x00000020)

FLAG_SUPPORTS_IS_CHILD

Added in API level 21
public static final int FLAG_SUPPORTS_IS_CHILD

Flag indicating that this root supports testing parent child relationships.

Constant Value: 16 (0x00000010)

FLAG_SUPPORTS_RECENTS

Added in API level 19
public static final int FLAG_SUPPORTS_RECENTS

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

Constant Value: 4 (0x00000004)

Added in API level 19
public static final int FLAG_SUPPORTS_SEARCH

Flag indicating that this root supports search.

Constant Value: 8 (0x00000008)

MIME_TYPE_ITEM

Added in API level 26
public static final String MIME_TYPE_ITEM

MIME type for a root.

Constant Value: "vnd.android.document/root"