Click or drag to resize

DocumentApiClient.DeleteDocumentAsync Method (String, DeleteDocumentQuery, DocumentHeaderProperties)

Delete a document based on its document ID.

Namespace:  ArangoDBNetStandard.DocumentApi
Assembly:  ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
Syntax
public virtual Task<DeleteDocumentResponse<Object>> DeleteDocumentAsync(
	string documentId,
	DeleteDocumentQuery query = null,
	DocumentHeaderProperties headers = null
)

Parameters

documentId
Type: System.String
query (Optional)
Type: ArangoDBNetStandard.DocumentApi.Models.DeleteDocumentQuery
headers (Optional)
Type: ArangoDBNetStandard.DocumentApi.Models.DocumentHeaderProperties
The DocumentHeaderProperties values.

Return Value

Type: Task<DeleteDocumentResponse<Object>>

Implements

IDocumentApiClient.DeleteDocumentAsync(String, DeleteDocumentQuery, DocumentHeaderProperties)
Remarks
This method overload is provided as a convenience when the client does not care about the type of Old in the returned DeleteDocumentResponse<T>. Its value will be null when ReturnOld is either false or not set, so this overload is useful in the default case when deleting documents.
See Also