IAggregateFluentExtensionsFirstAsyncTResult Method |
Returns the first document of the aggregate result.
Namespace: MongoDB.DriverAssembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.4.1
Syntax public static Task<TResult> FirstAsync<TResult>(
this IAggregateFluent<TResult> aggregate,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function FirstAsync(Of TResult) (
aggregate As IAggregateFluent(Of TResult),
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TResult)
[<ExtensionAttribute>]
static member FirstAsync :
aggregate : IAggregateFluent<'TResult> *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<'TResult>
Parameters
- aggregate
- Type: MongoDB.DriverIAggregateFluentTResult
The aggregate. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TResult
- The type of the result.
Return Value
Type:
TaskTResult
The fluent aggregate interface.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IAggregateFluentTResult. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also