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 | |
|---|---|
java.lang.Object
| |
Constants
COLUMN_AVAILABLE_BYTES
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
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
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
String COLUMN_FLAGS
Flags that apply to a root. This column is required.
Type: INTEGER (int)
Constant Value: "flags"
COLUMN_ICON
String COLUMN_ICON
Icon resource ID for a root. This column is required.
Type: INTEGER (int)
Constant Value: "icon"
COLUMN_MIME_TYPES
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
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
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
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
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
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
int FLAG_SUPPORTS_IS_CHILD
Flag indicating that this root supports testing parent child relationships.
Constant Value: 16 (0x00000010)
FLAG_SUPPORTS_RECENTS
int FLAG_SUPPORTS_RECENTS
Flag indicating that this root can be queried to provide recently modified documents.
Constant Value: 4 (0x00000004)
FLAG_SUPPORTS_SEARCH
int FLAG_SUPPORTS_SEARCH
Flag indicating that this root supports search.
See also:
Constant Value: 8 (0x00000008)
Interfaces
- BaseColumns
- CalendarContract.AttendeesColumns
- CalendarContract.CalendarAlertsColumns
- CalendarContract.CalendarCacheColumns
- CalendarContract.CalendarColumns
- CalendarContract.CalendarSyncColumns
- CalendarContract.ColorsColumns
- CalendarContract.EventDaysColumns
- CalendarContract.EventsColumns
- CalendarContract.ExtendedPropertiesColumns
- CalendarContract.RemindersColumns
- CalendarContract.SyncColumns
- Contacts.ContactMethodsColumns
- Contacts.ExtensionsColumns
- Contacts.GroupsColumns
- Contacts.OrganizationColumns
- Contacts.PeopleColumns
- Contacts.PhonesColumns
- Contacts.PhotosColumns
- Contacts.PresenceColumns
- Contacts.SettingsColumns
- ContactsContract.BaseSyncColumns
- ContactsContract.CommonDataKinds.BaseTypes
- ContactsContract.CommonDataKinds.CommonColumns
- ContactsContract.ContactNameColumns
- ContactsContract.ContactOptionsColumns
- ContactsContract.ContactsColumns
- ContactsContract.ContactStatusColumns
- ContactsContract.DataColumns
- ContactsContract.DataColumnsWithJoins
- ContactsContract.DataUsageStatColumns
- ContactsContract.DeletedContactsColumns
- ContactsContract.DisplayNameSources
- ContactsContract.FullNameStyle
- ContactsContract.GroupsColumns
- ContactsContract.PhoneLookupColumns
- ContactsContract.PhoneticNameStyle
- ContactsContract.PresenceColumns
- ContactsContract.RawContactsColumns
- ContactsContract.SettingsColumns
- ContactsContract.StatusColumns
- ContactsContract.SyncColumns
- MediaStore.Audio.AlbumColumns
- MediaStore.Audio.ArtistColumns
- MediaStore.Audio.AudioColumns
- MediaStore.Audio.GenresColumns
- MediaStore.Audio.PlaylistsColumns
- MediaStore.Files.FileColumns
- MediaStore.Images.ImageColumns
- MediaStore.MediaColumns
- MediaStore.Video.VideoColumns
- OpenableColumns
- SyncStateContract.Columns
- Telephony.BaseMmsColumns
- Telephony.CanonicalAddressesColumns
- Telephony.TextBasedSmsColumns
- Telephony.ThreadsColumns
Classes
- AlarmClock
- BlockedNumberContract
- BlockedNumberContract.BlockedNumbers
- Browser
- CalendarContract
- CalendarContract.Attendees
- CalendarContract.CalendarAlerts
- CalendarContract.CalendarCache
- CalendarContract.CalendarEntity
- CalendarContract.Calendars
- CalendarContract.Colors
- CalendarContract.EventDays
- CalendarContract.Events
- CalendarContract.EventsEntity
- CalendarContract.ExtendedProperties
- CalendarContract.Instances
- CalendarContract.Reminders
- CalendarContract.SyncState
- CallLog
- CallLog.Calls
- Contacts
- Contacts.ContactMethods
- Contacts.Extensions
- Contacts.GroupMembership
- Contacts.Groups
- Contacts.Intents
- Contacts.Intents.Insert
- Contacts.Intents.UI
- Contacts.Organizations
- Contacts.People
- Contacts.People.ContactMethods
- Contacts.People.Extensions
- Contacts.People.Phones
- Contacts.Phones
- Contacts.Photos
- Contacts.Settings
- ContactsContract
- ContactsContract.AggregationExceptions
- ContactsContract.CommonDataKinds
- ContactsContract.CommonDataKinds.Callable
- ContactsContract.CommonDataKinds.Contactables
- ContactsContract.CommonDataKinds.Email
- ContactsContract.CommonDataKinds.Event
- ContactsContract.CommonDataKinds.GroupMembership
- ContactsContract.CommonDataKinds.Identity
- ContactsContract.CommonDataKinds.Im
- ContactsContract.CommonDataKinds.Nickname
- ContactsContract.CommonDataKinds.Note
- ContactsContract.CommonDataKinds.Organization
- ContactsContract.CommonDataKinds.Phone
- ContactsContract.CommonDataKinds.Photo
- ContactsContract.CommonDataKinds.Relation
- ContactsContract.CommonDataKinds.SipAddress
- ContactsContract.CommonDataKinds.StructuredName
- ContactsContract.CommonDataKinds.StructuredPostal
- ContactsContract.CommonDataKinds.Website
- ContactsContract.Contacts
- ContactsContract.Contacts.AggregationSuggestions
- ContactsContract.Contacts.AggregationSuggestions.Builder
- ContactsContract.Contacts.Data
- ContactsContract.Contacts.Entity
- ContactsContract.Contacts.Photo
- ContactsContract.Data
- ContactsContract.DataUsageFeedback
- ContactsContract.DeletedContacts
- ContactsContract.Directory
- ContactsContract.DisplayPhoto
- ContactsContract.Groups
- ContactsContract.Intents
- ContactsContract.Intents.Insert
- ContactsContract.PhoneLookup
- ContactsContract.PinnedPositions
- ContactsContract.Presence
- ContactsContract.Profile
- ContactsContract.ProfileSyncState
- ContactsContract.ProviderStatus
- ContactsContract.QuickContact
- ContactsContract.RawContacts
- ContactsContract.RawContacts.Data
- ContactsContract.RawContacts.DisplayPhoto
- ContactsContract.RawContacts.Entity
- ContactsContract.RawContactsEntity
- ContactsContract.SearchSnippets
- ContactsContract.Settings
- ContactsContract.StatusUpdates
- ContactsContract.SyncState
- DocumentsContract
- DocumentsContract.Document
- DocumentsContract.Root
- DocumentsProvider
- LiveFolders
- MediaStore
- MediaStore.Audio
- MediaStore.Audio.Albums
- MediaStore.Audio.Artists
- MediaStore.Audio.Artists.Albums
- MediaStore.Audio.Genres
- MediaStore.Audio.Genres.Members
- MediaStore.Audio.Media
- MediaStore.Audio.Playlists
- MediaStore.Audio.Playlists.Members
- MediaStore.Audio.Radio
- MediaStore.Files
- MediaStore.Images
- MediaStore.Images.Media
- MediaStore.Images.Thumbnails
- MediaStore.Video
- MediaStore.Video.Media
- MediaStore.Video.Thumbnails
- SearchRecentSuggestions
- Settings
- Settings.Global
- Settings.NameValueTable
- Settings.Secure
- Settings.System
- SyncStateContract
- SyncStateContract.Constants
- SyncStateContract.Helpers
- Telephony
- Telephony.Carriers
- Telephony.Mms
- Telephony.Mms.Addr
- Telephony.Mms.Draft
- Telephony.Mms.Inbox
- Telephony.Mms.Intents
- Telephony.Mms.Outbox
- Telephony.Mms.Part
- Telephony.Mms.Rate
- Telephony.Mms.Sent
- Telephony.MmsSms
- Telephony.MmsSms.PendingMessages
- Telephony.Sms
- Telephony.Sms.Conversations
- Telephony.Sms.Draft
- Telephony.Sms.Inbox
- Telephony.Sms.Intents
- Telephony.Sms.Outbox
- Telephony.Sms.Sent
- Telephony.Threads
- UserDictionary
- UserDictionary.Words
- VoicemailContract
- VoicemailContract.Status
- VoicemailContract.Voicemails
Exceptions

