DocumentsProvider.TrashDocument(String) Method

Definition

Namespace:: Android.Provider

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Trash the requested document.

[Android.Runtime.Register("trashDocument", "(Ljava/lang/String;)Ljava/lang/String;", "GetTrashDocument_Ljava_lang_String_Handler", ApiSince=37)]
public virtual string? TrashDocument(string documentId);

[<Android.Runtime.Register("trashDocument", "(Ljava/lang/String;)Ljava/lang/String;", "GetTrashDocument_Ljava_lang_String_Handler", ApiSince=37)>]
abstract member TrashDocument : string -> string
override this.TrashDocument : string -> string

Parameters

documentId: String

the document to trash.

Returns

String

the document id of the trashed document or return null in case of failure.

Attributes: RegisterAttribute

Remarks

Trash the requested document.

Upon trashing a document, the document will be marked as trashed. It will not be accessible other then trash page until restoreDocumentFromTrash(String,String). Any URI permission grants for the given document will be revoked.

Android reference for android.provider.DocumentsProvider.trashDocument.

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