Click or drag to resize

DocumentApiClientDeleteDocumentAsync Method (String, String, DeleteDocumentQuery, DocumentHeaderProperties)

Delete a document.

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

Parameters

collectionName
Type: SystemString
documentKey
Type: SystemString
query (Optional)
Type: ArangoDBNetStandard.DocumentApi.ModelsDeleteDocumentQuery
headers (Optional)
Type: ArangoDBNetStandard.DocumentApi.ModelsDocumentHeaderProperties
The DocumentHeaderProperties values.

Return Value

Type: TaskDeleteDocumentResponseObject

Implements

IDocumentApiClientDeleteDocumentAsync(String, 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 DeleteDocumentResponseT. 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