Links
Android Sites
Language
Results
Loading...
| 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.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | COLUMN_AVAILABLE_BYTES | Number of bytes available in this root. | |||||||||
| 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_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. | |||||||||
|
[Expand]
Inherited Methods
|
|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
|||||||||||
Number of bytes available in this root. This column is optional, and
may be
null
if unknown or unbounded.
Type: INTEGER (long)
Document which is a directory that represents the top directory of this root. This column is required.
Type: STRING
Flags that apply to a root. This column is required.
Type: INTEGER (int)
Icon resource ID for a root. This column is required.
Type: INTEGER (int)
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
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
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
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
Flag indicating that this root offers content that is strictly local on the device. That is, no network requests are made for the content.
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
.
Flag indicating that this root can be queried to provide recently modified documents.
Flag indicating that this root supports search.