DocumentsProvider.MoveDocument(String, String, String) Method

Definition

Namespace:

Android.Provider

Assembly:

Mono.Android.dll

Move the requested document or a document tree.

[Android.Runtime.Register("moveDocument", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;", "GetMoveDocument_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_Handler", ApiSince=24)]
public virtual string? MoveDocument (string? sourceDocumentId, string? sourceParentDocumentId, string? targetParentDocumentId);

[<Android.Runtime.Register("moveDocument", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;", "GetMoveDocument_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_Handler", ApiSince=24)>]
abstract member MoveDocument : string * string * string -> string
override this.MoveDocument : string * string * string -> string

Parameters

sourceDocumentId

String

the document to move.

sourceParentDocumentId

String

the parent of the document to move.

targetParentDocumentId

String

the target document to be a new parent of the source document.

Returns

String

Attributes

RegisterAttribute

Remarks

Move the requested document or a document tree.

Moves a document including all child documents to another location within the same document provider. Upon completion returns the document id of the copied document at the target destination. null must never be returned.

It's the responsibility of the provider to revoke grants if the document is no longer accessible using sourceDocumentId.

Java documentation for android.provider.DocumentsProvider.moveDocument(java.lang.String, java.lang.String, 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.