IndexActionEventArgs<T> Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
IndexActionEventArgs.cs
Source:
IndexActionEventArgs.cs

Provides data for ActionAdded and ActionSent events.

public class IndexActionEventArgs<T> : Azure.SyncAsyncEventArgs
type IndexActionEventArgs<'T> = class
    inherit SyncAsyncEventArgs
Public Class IndexActionEventArgs(Of T)
Inherits SyncAsyncEventArgs

Type Parameters

T

The .NET type that maps to the index schema. Instances of this type can be retrieved as documents from the index. You can use SearchDocument for dynamic documents.

Inheritance
EventArgs
SyncAsyncEventArgs
IndexActionEventArgs<T>
Derived

Constructors

IndexActionEventArgs<T>(SearchIndexingBufferedSender<T>, IndexDocumentsAction<T>, Boolean, CancellationToken)

Initializes a new instance of the IndexActionEventArgs<T> class.

Properties

Action

Gets the IndexDocumentsAction<T> that was added, sent, completed, or failed.
CancellationToken

Gets a cancellation token related to the original operation that raised the event. It's important for your handler to pass this token along to any asynchronous or long-running synchronous operations that take a token so cancellation (via something like

new CancellationTokenSource(TimeSpan.FromSeconds(10)).Token

for example) will correctly propagate.

(Inherited from SyncAsyncEventArgs)
IsRunningSynchronously

Gets a value indicating whether the event handler was invoked synchronously or asynchronously. Please see SyncAsyncEventHandler<T> for more details.

(Inherited from SyncAsyncEventArgs)
Sender

Gets the SearchIndexingBufferedSender<T> raising the event.

Applies to