SelfServicingExtensionMethodsGetSingleAsyncTEntity Method (EntityQueryTEntity, CancellationToken)

Async variant of GetSingleTEntity(EntityQueryTEntity). Fetches the single entity of the set returned by the query and returns that entity. If there are no elements or more than 1 element, a NotSupportedException will be thrown.

Namespace: SD.LLBLGen.Pro.QuerySpec.SelfServicing
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.6.0.0 (5.6.19.0117)

Syntax

Copy

public static Task<TEntity> GetSingleAsync<TEntity>(
	this EntityQuery<TEntity> query,
	CancellationToken cancellationToken
)
where TEntity : EntityBase, IEntity

<ExtensionAttribute>
Public Shared Function GetSingleAsync(Of TEntity As {EntityBase, IEntity}) ( 
	query As EntityQuery(Of TEntity),
	cancellationToken As CancellationToken
) As Task(Of TEntity)

Parameters

query: Type: SD.LLBLGen.Pro.QuerySpecEntityQueryTEntity
The query.
cancellationToken: Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TEntity: The type of the entity.

Return Value

Type: TaskTEntity
the first entity in the resultset

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type EntityQueryTEntity. 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).

Exceptions

Exception	Condition
NotSupportedException	Thrown if the resultset has 0 or 2 or more elements, as Single requires a single value in the resultset.

Reference

SelfServicingExtensionMethods Class

GetSingleAsync Overload

SD.LLBLGen.Pro.QuerySpec.SelfServicing Namespace