Merge "Update API documentation about virtual files."

This commit is contained in:
Tomasz Mikolajewski
2017-01-05 05:03:29 +00:00
committed by Android (Google) Code Review
2 changed files with 7 additions and 0 deletions

View File

@@ -393,6 +393,9 @@ public final class DocumentsContract {
* Flag indicating that a document is virtual, and doesn't have byte
* representation in the MIME type specified as {@link #COLUMN_MIME_TYPE}.
*
* <p><em>Virtual documents must have at least one alternative streamable
* format via {@link DocumentsProvider#openTypedDocument}</em>
*
* @see #COLUMN_FLAGS
* @see #COLUMN_MIME_TYPE
* @see DocumentsProvider#openTypedDocument(String, String, Bundle,

View File

@@ -575,6 +575,8 @@ public abstract class DocumentsProvider extends ContentProvider {
* <p>
* A provider may perform a conversion if the documents's MIME type is not
* matching the specified MIME type filter.
* <p>
* Virtual documents must have at least one streamable format.
*
* @param documentId the document to return.
* @param mimeTypeFilter the MIME type filter for the requested format. May
@@ -1044,6 +1046,8 @@ public abstract class DocumentsProvider extends ContentProvider {
* {@link #queryDocument(String, String[])} as long as it matches the filter and the document
* does not have the {@link Document#FLAG_VIRTUAL_DOCUMENT} flag set.
*
* <p>Virtual documents must have at least one streamable format.
*
* @see #getStreamTypes(Uri, String)
* @see #openTypedDocument(String, String, Bundle, CancellationSignal)
*/