SearchIndexingBufferedSender<T>.DeleteDocumentsAsync Method

Definition

Adds a batch of delete actions to eventually send to the search index.

public virtual System.Threading.Tasks.Task DeleteDocumentsAsync (System.Collections.Generic.IEnumerable<T> documents, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteDocumentsAsync : seq<'T> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteDocumentsAsync : seq<'T> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function DeleteDocumentsAsync (documents As IEnumerable(Of T), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

documents
IEnumerable<T>

The documents to delete.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

A task that completes when the indexing actions have been added but not yet sent.

Applies to