MongoCollectionBaseTDocumentWatchAsyncTResult Method (PipelineDefinitionChangeStreamDocumentTDocument, TResult, ChangeStreamOptions, CancellationToken) | 
 
            Watches changes on the collection.
            
 
    Namespace: 
   MongoDB.Driver
    Assembly:
   MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntaxpublic virtual Task<IChangeStreamCursor<TResult>> WatchAsync<TResult>(
	PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline,
	ChangeStreamOptions options = null,
	CancellationToken cancellationToken = default
)
Public Overridable Function WatchAsync(Of TResult) ( 
	pipeline As PipelineDefinition(Of ChangeStreamDocument(Of TDocument), TResult),
	Optional options As ChangeStreamOptions = Nothing,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IChangeStreamCursor(Of TResult))
abstract WatchAsync : 
        pipeline : PipelineDefinition<ChangeStreamDocument<'TDocument>, 'TResult> * 
        ?options : ChangeStreamOptions * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _options = defaultArg options null
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IChangeStreamCursor<'TResult>> 
override WatchAsync : 
        pipeline : PipelineDefinition<ChangeStreamDocument<'TDocument>, 'TResult> * 
        ?options : ChangeStreamOptions * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _options = defaultArg options null
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IChangeStreamCursor<'TResult>> Parameters
- pipeline
 - Type: MongoDB.DriverPipelineDefinitionChangeStreamDocumentTDocument, TResult
The pipeline. - options (Optional)
 - Type: MongoDB.DriverChangeStreamOptions
The options. - cancellationToken (Optional)
 - Type: System.ThreadingCancellationToken
The cancellation token. 
Type Parameters
- TResult
 - The type of the result.
 
Return Value
Type: 
TaskIChangeStreamCursorTResult
            A change stream.
            
Implements
IMongoCollectionTDocumentWatchAsyncTResult(PipelineDefinitionChangeStreamDocumentTDocument, TResult, ChangeStreamOptions, CancellationToken)
See Also