DocumentApiClientDeleteDocumentAsync 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
)
Public Overridable Function DeleteDocumentAsync (
documentId As String,
Optional query As DeleteDocumentQuery = Nothing,
Optional headers As DocumentHeaderProperties = Nothing
) As Task(Of DeleteDocumentResponse(Of Object))
public:
virtual Task<DeleteDocumentResponse<Object^>^>^ DeleteDocumentAsync(
String^ documentId,
DeleteDocumentQuery^ query = nullptr,
DocumentHeaderProperties^ headers = nullptr
)
abstract DeleteDocumentAsync :
documentId : string *
?query : DeleteDocumentQuery *
?headers : DocumentHeaderProperties
(* Defaults:
let _query = defaultArg query null
let _headers = defaultArg headers null
*)
-> Task<DeleteDocumentResponse<Object>>
override DeleteDocumentAsync :
documentId : string *
?query : DeleteDocumentQuery *
?headers : DocumentHeaderProperties
(* Defaults:
let _query = defaultArg query null
let _headers = defaultArg headers null
*)
-> Task<DeleteDocumentResponse<Object>>
Parameters
- documentId
- Type: SystemString
- query (Optional)
- Type: ArangoDBNetStandard.DocumentApi.ModelsDeleteDocumentQuery
- headers (Optional)
- Type: ArangoDBNetStandard.DocumentApi.ModelsDocumentHeaderProperties
The DocumentHeaderProperties values.
Return Value
Type:
TaskDeleteDocumentResponseObjectImplements
IDocumentApiClientDeleteDocumentAsync(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