Class BatchUpdateIndexFieldsResult

Structure for the result of batch update operations.

Inheritance

System.Object

BatchUpdateIndexFieldsResult

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class BatchUpdateIndexFieldsResult : IRelationsWithProxy

Properties

Item

List of the resulting documents and errors.

Declaration

public List<BatchUpdateResultItem> Item { get; set; }

Property Value

Type	Description
List<BatchUpdateResultItem>

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

NextRelationLink

Gets the Uri of the link for the relation “next”.

Declaration

public string NextRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “next” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

SuccessCount

The number of successful updated documents.

Declaration

public int SuccessCount { get; set; }

Property Value

Type	Description
System.Int32

Methods

PostToNextRelationForBatchUpdateIndexFieldsResult(BatchUpdateProcessData)

Calls the HTTP Post method on the link for the relation “next”.

Declaration

public BatchUpdateIndexFieldsResult PostToNextRelationForBatchUpdateIndexFieldsResult(BatchUpdateProcessData dataToSend)

Parameters

Type	Name	Description
BatchUpdateProcessData	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
BatchUpdateIndexFieldsResult	The content of the response.

PostToNextRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcessData)

Calls the HTTP Post method on the link for the relation “next” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToNextRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcessData dataToSend)

Parameters

Type	Name	Description
BatchUpdateProcessData	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>>	A task which runs the request.

Remarks

This method follows the link for the relation “next”.

PostToNextRelationForBatchUpdateIndexFieldsResultAsync(System.Threading.CancellationToken, BatchUpdateProcessData)

Calls the HTTP Post method on the link for the relation “next” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToNextRelationForBatchUpdateIndexFieldsResultAsync(System.Threading.CancellationToken cancellationToken, BatchUpdateProcessData dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
BatchUpdateProcessData	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>>	A task which runs the request.

Remarks

This method follows the link for the relation “next”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The instance which is used in further HTTP communication.

Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.