Click or drag to resize

DocumentApiClientDeleteDocumentsAsync Method (String, IListString, DeleteDocumentsQuery, DocumentHeaderProperties)

Delete multiple documents based on the passed document selectors. A document selector is either the document ID or the document Key.

Namespace:  ArangoDBNetStandard.DocumentApi
Assembly:  ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
Syntax
public virtual Task<DeleteDocumentsResponse<Object>> DeleteDocumentsAsync(
	string collectionName,
	IList<string> selectors,
	DeleteDocumentsQuery query = null,
	DocumentHeaderProperties headers = null
)

Parameters

collectionName
Type: SystemString
selectors
Type: System.Collections.GenericIListString
query (Optional)
Type: ArangoDBNetStandard.DocumentApi.ModelsDeleteDocumentsQuery
headers (Optional)
Type: ArangoDBNetStandard.DocumentApi.ModelsDocumentHeaderProperties
The DocumentHeaderProperties values.

Return Value

Type: TaskDeleteDocumentsResponseObject

Implements

IDocumentApiClientDeleteDocumentsAsync(String, IListString, DeleteDocumentsQuery, DocumentHeaderProperties)
Remarks
This method overload is provided as a convenience when the client does not care about the type of Old in the returned DeleteDocumentsResponseT. These 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