DocumentsProvider.GetDocumentMetadata(String) Method

Definition

Returns metadata associated with the document.

[Android.Runtime.Register("getDocumentMetadata", "(Ljava/lang/String;)Landroid/os/Bundle;", "GetGetDocumentMetadata_Ljava_lang_String_Handler", ApiSince=29)]
public virtual Android.OS.Bundle? GetDocumentMetadata (string documentId);
[<Android.Runtime.Register("getDocumentMetadata", "(Ljava/lang/String;)Landroid/os/Bundle;", "GetGetDocumentMetadata_Ljava_lang_String_Handler", ApiSince=29)>]
abstract member GetDocumentMetadata : string -> Android.OS.Bundle
override this.GetDocumentMetadata : string -> Android.OS.Bundle

Parameters

documentId
String

get the metadata of the document

Returns

a Bundle of Bundles.

Attributes

Remarks

Returns metadata associated with the document. The type of metadata returned is specific to the document type. For example the data returned for an image file will likely consist primarily or solely of EXIF metadata.

The returned Bundle will contain zero or more entries depending on the type of data supported by the document provider.

<ol> <li>A DocumentsContract#METADATA_TYPES containing a String[] value. The string array identifies the type or types of metadata returned. Each value in the can be used to access a Bundle of data containing that type of data. <li>An entry each for each type of returned metadata. Each set of metadata is itself represented as a bundle and accessible via a string key naming the type of data. </ol>

Java documentation for android.provider.DocumentsProvider.getDocumentMetadata(java.lang.String).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to