DocumentApiClientPostDocumentAsyncT, U Method (String, T, PostDocumentsQuery, ApiClientSerializationOptions, DocumentHeaderProperties) |
Post a single document with the possibility to specify a different type
for the new document object returned in the response.
Namespace:
ArangoDBNetStandard.DocumentApi
Assembly:
ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
Syntax public virtual Task<PostDocumentResponse<U>> PostDocumentAsync<T, U>(
string collectionName,
T document,
PostDocumentsQuery query = null,
ApiClientSerializationOptions serializationOptions = null,
DocumentHeaderProperties headers = null
)
Public Overridable Function PostDocumentAsync(Of T, U) (
collectionName As String,
document As T,
Optional query As PostDocumentsQuery = Nothing,
Optional serializationOptions As ApiClientSerializationOptions = Nothing,
Optional headers As DocumentHeaderProperties = Nothing
) As Task(Of PostDocumentResponse(Of U))
public:
generic<typename T, typename U>
virtual Task<PostDocumentResponse<U>^>^ PostDocumentAsync(
String^ collectionName,
T document,
PostDocumentsQuery^ query = nullptr,
ApiClientSerializationOptions^ serializationOptions = nullptr,
DocumentHeaderProperties^ headers = nullptr
)
abstract PostDocumentAsync :
collectionName : string *
document : 'T *
?query : PostDocumentsQuery *
?serializationOptions : ApiClientSerializationOptions *
?headers : DocumentHeaderProperties
(* Defaults:
let _query = defaultArg query null
let _serializationOptions = defaultArg serializationOptions null
let _headers = defaultArg headers null
*)
-> Task<PostDocumentResponse<'U>>
override PostDocumentAsync :
collectionName : string *
document : 'T *
?query : PostDocumentsQuery *
?serializationOptions : ApiClientSerializationOptions *
?headers : DocumentHeaderProperties
(* Defaults:
let _query = defaultArg query null
let _serializationOptions = defaultArg serializationOptions null
let _headers = defaultArg headers null
*)
-> Task<PostDocumentResponse<'U>>
Parameters
- collectionName
- Type: SystemString
- document
- Type: T
- query (Optional)
- Type: ArangoDBNetStandard.DocumentApi.ModelsPostDocumentsQuery
- serializationOptions (Optional)
- Type: ArangoDBNetStandard.SerializationApiClientSerializationOptions
The serialization options. When the value is null the
the serialization options should be provided by the serializer, otherwise the given options should be used. - headers (Optional)
- Type: ArangoDBNetStandard.DocumentApi.ModelsDocumentHeaderProperties
The DocumentHeaderProperties values.
Type Parameters
- T
- The type of the post object used to record a new document.
- U
- Type of the returned document, only applies when
ReturnNew or ReturnOld
are used.
Return Value
Type:
TaskPostDocumentResponseUImplements
IDocumentApiClientPostDocumentAsyncT, U(String, T, PostDocumentsQuery, ApiClientSerializationOptions, DocumentHeaderProperties)See Also