Share via


DocumentsProvider.OpenTypedDocument Method

Definition

Open and return the document in a format matching the specified MIME type filter.

[Android.Runtime.Register("openTypedDocument", "(Ljava/lang/String;Ljava/lang/String;Landroid/os/Bundle;Landroid/os/CancellationSignal;)Landroid/content/res/AssetFileDescriptor;", "GetOpenTypedDocument_Ljava_lang_String_Ljava_lang_String_Landroid_os_Bundle_Landroid_os_CancellationSignal_Handler", ApiSince=24)]
public virtual Android.Content.Res.AssetFileDescriptor? OpenTypedDocument (string? documentId, string? mimeTypeFilter, Android.OS.Bundle? opts, Android.OS.CancellationSignal? signal);
[<Android.Runtime.Register("openTypedDocument", "(Ljava/lang/String;Ljava/lang/String;Landroid/os/Bundle;Landroid/os/CancellationSignal;)Landroid/content/res/AssetFileDescriptor;", "GetOpenTypedDocument_Ljava_lang_String_Ljava_lang_String_Landroid_os_Bundle_Landroid_os_CancellationSignal_Handler", ApiSince=24)>]
abstract member OpenTypedDocument : string * string * Android.OS.Bundle * Android.OS.CancellationSignal -> Android.Content.Res.AssetFileDescriptor
override this.OpenTypedDocument : string * string * Android.OS.Bundle * Android.OS.CancellationSignal -> Android.Content.Res.AssetFileDescriptor

Parameters

documentId
String

the document to return.

mimeTypeFilter
String

the MIME type filter for the requested format. May be /, which matches any MIME type.

opts
Bundle

extra options from the client. Specific to the content provider.

signal
CancellationSignal

used by the caller to signal if the request should be cancelled. May be null.

Returns

Attributes

Remarks

Open and return the document in a format matching the specified MIME type filter.

A provider may perform a conversion if the documents's MIME type is not matching the specified MIME type filter.

Virtual documents must have at least one streamable format.

Java documentation for android.provider.DocumentsProvider.openTypedDocument(java.lang.String, java.lang.String, android.os.Bundle, android.os.CancellationSignal).

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