Search Results for

    Show / Hide Table of Contents

    Class EndpointWithoutRequest<TResponse>

    use this base class for defining endpoints that doesn't need a request dto but return a response dto.

    Inheritance
    object
    BaseEndpoint
    Endpoint<EmptyRequest, TResponse>
    EndpointWithoutRequest<TResponse>
    EndpointWithoutRequest<TResponse, TMapper>
    Ep.NoReq.Res<TResponse>
    Implements
    IEndpoint
    IEventBus
    IServiceResolverBase
    INoRequest
    Inherited Members
    Endpoint<EmptyRequest, TResponse>.HandleAsync(EmptyRequest, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.ExecuteAsync(EmptyRequest, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.TryResolve<TService>()
    Endpoint<EmptyRequest, TResponse>.TryResolve(Type)
    Endpoint<EmptyRequest, TResponse>.Resolve<TService>()
    Endpoint<EmptyRequest, TResponse>.Resolve(Type)
    Endpoint<EmptyRequest, TResponse>.CreateScope()
    Endpoint<EmptyRequest, TResponse>.TryResolve<TService>(string)
    Endpoint<EmptyRequest, TResponse>.TryResolve(Type, string)
    Endpoint<EmptyRequest, TResponse>.Resolve<TService>(string)
    Endpoint<EmptyRequest, TResponse>.Resolve(Type, string)
    Endpoint<EmptyRequest, TResponse>.Route<T>(string, bool)
    Endpoint<EmptyRequest, TResponse>.Query<T>(string, bool)
    Endpoint<EmptyRequest, TResponse>.FormFileSectionsAsync(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.FormMultipartSectionsAsync(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.PublishAsync<TEvent>(TEvent, Mode, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.CreateTokenWith<TService>(string, Action<UserPrivileges>, EmptyRequest)
    Endpoint<EmptyRequest, TResponse>.ProcessorState<TState>()
    Endpoint<EmptyRequest, TResponse>.OnBeforeValidate(EmptyRequest)
    Endpoint<EmptyRequest, TResponse>.OnBeforeValidateAsync(EmptyRequest, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.OnAfterValidate(EmptyRequest)
    Endpoint<EmptyRequest, TResponse>.OnAfterValidateAsync(EmptyRequest, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.OnBeforeHandle(EmptyRequest)
    Endpoint<EmptyRequest, TResponse>.OnBeforeHandleAsync(EmptyRequest, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.OnAfterHandle(EmptyRequest, TResponse)
    Endpoint<EmptyRequest, TResponse>.OnAfterHandleAsync(EmptyRequest, TResponse, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.OnValidationFailed()
    Endpoint<EmptyRequest, TResponse>.OnValidationFailedAsync(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.User
    Endpoint<EmptyRequest, TResponse>.Response
    Endpoint<EmptyRequest, TResponse>.Config
    Endpoint<EmptyRequest, TResponse>.Env
    Endpoint<EmptyRequest, TResponse>.Logger
    Endpoint<EmptyRequest, TResponse>.BaseURL
    Endpoint<EmptyRequest, TResponse>.HttpMethod
    Endpoint<EmptyRequest, TResponse>.Form
    Endpoint<EmptyRequest, TResponse>.Files
    Endpoint<EmptyRequest, TResponse>.ResponseStarted
    Endpoint<EmptyRequest, TResponse>.SendAsync(TResponse, int, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendResultAsync(IResult)
    Endpoint<EmptyRequest, TResponse>.SendInterceptedAsync(object, int, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendCreatedAtAsync<TEndpoint>(object, TResponse, Http?, int?, bool, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendCreatedAtAsync(string, object, TResponse, bool, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendAcceptedAtAsync<TEndpoint>(object, TResponse, Http?, int?, bool, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendAcceptedAtAsync(string, object, TResponse, bool, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendStringAsync(string, int, string, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendOkAsync(TResponse, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendOkAsync(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendErrorsAsync(int, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendNoContentAsync(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendNotFoundAsync(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendUnauthorizedAsync(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendForbiddenAsync(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendRedirectAsync(string, bool, bool)
    Endpoint<EmptyRequest, TResponse>.SendHeadersAsync(Action<IHeaderDictionary>, int, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendBytesAsync(byte[], string, string, DateTimeOffset?, bool, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendFileAsync(FileInfo, string, DateTimeOffset?, bool, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendStreamAsync(Stream, string, long?, string, DateTimeOffset?, bool, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendEventStreamAsync<T>(string, IAsyncEnumerable<T>, CancellationToken)
    Endpoint<EmptyRequest, TResponse>.SendEmptyJsonObject(CancellationToken)
    Endpoint<EmptyRequest, TResponse>.AccessControl(string, Apply?, params string[])
    Endpoint<EmptyRequest, TResponse>.AccessControl(string, params string[])
    Endpoint<EmptyRequest, TResponse>.AllowAnonymous(params Http[])
    Endpoint<EmptyRequest, TResponse>.AllowAnonymous(string[])
    Endpoint<EmptyRequest, TResponse>.AllowFileUploads(bool)
    Endpoint<EmptyRequest, TResponse>.AllowFormData(bool)
    Endpoint<EmptyRequest, TResponse>.AuthSchemes(params string[])
    Endpoint<EmptyRequest, TResponse>.Claims(params string[])
    Endpoint<EmptyRequest, TResponse>.ClaimsAll(params string[])
    Endpoint<EmptyRequest, TResponse>.Connect(params string[])
    Endpoint<EmptyRequest, TResponse>.Connect(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.Delete(params string[])
    Endpoint<EmptyRequest, TResponse>.Delete(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.Description(Action<RouteHandlerBuilder>, bool)
    Endpoint<EmptyRequest, TResponse>.DontAutoSendResponse()
    Endpoint<EmptyRequest, TResponse>.DontAutoTag()
    Endpoint<EmptyRequest, TResponse>.DontCatchExceptions()
    Endpoint<EmptyRequest, TResponse>.DontThrowIfValidationFails()
    Endpoint<EmptyRequest, TResponse>.EnableAntiforgery()
    Endpoint<EmptyRequest, TResponse>.Get(params string[])
    Endpoint<EmptyRequest, TResponse>.Get(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.Group<TEndpointGroup>()
    Endpoint<EmptyRequest, TResponse>.Head(params string[])
    Endpoint<EmptyRequest, TResponse>.Head(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.Idempotency(Action<IdempotencyOptions>)
    Endpoint<EmptyRequest, TResponse>.Options(Action<RouteHandlerBuilder>)
    Endpoint<EmptyRequest, TResponse>.Options(params string[])
    Endpoint<EmptyRequest, TResponse>.Options(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.Patch(params string[])
    Endpoint<EmptyRequest, TResponse>.Patch(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.Permissions(params string[])
    Endpoint<EmptyRequest, TResponse>.PermissionsAll(params string[])
    Endpoint<EmptyRequest, TResponse>.Policy(Action<AuthorizationPolicyBuilder>)
    Endpoint<EmptyRequest, TResponse>.Policies(params string[])
    Endpoint<EmptyRequest, TResponse>.Post(params string[])
    Endpoint<EmptyRequest, TResponse>.Post(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.PostProcessor<TPostProcessor>()
    Endpoint<EmptyRequest, TResponse>.PostProcessors(params IPostProcessor<EmptyRequest, TResponse>[])
    Endpoint<EmptyRequest, TResponse>.PreProcessor<TPreProcessor>()
    Endpoint<EmptyRequest, TResponse>.PreProcessors(params IPreProcessor<EmptyRequest>[])
    Endpoint<EmptyRequest, TResponse>.Put(params string[])
    Endpoint<EmptyRequest, TResponse>.Put(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.RequestBinder(IRequestBinder<EmptyRequest>)
    Endpoint<EmptyRequest, TResponse>.ResponseCache(int, ResponseCacheLocation, bool, string, string[])
    Endpoint<EmptyRequest, TResponse>.ResponseInterceptor(IResponseInterceptor)
    Endpoint<EmptyRequest, TResponse>.Roles(params string[])
    Endpoint<EmptyRequest, TResponse>.RoutePrefixOverride(string)
    Endpoint<EmptyRequest, TResponse>.Routes(params string[])
    Endpoint<EmptyRequest, TResponse>.SerializerContext<TContext>(TContext)
    Endpoint<EmptyRequest, TResponse>.SerializerContext<TContext>()
    Endpoint<EmptyRequest, TResponse>.Summary(Action<EndpointSummary>)
    Endpoint<EmptyRequest, TResponse>.Summary(Action<EndpointSummary<EmptyRequest>>)
    Endpoint<EmptyRequest, TResponse>.Summary(EndpointSummary)
    Endpoint<EmptyRequest, TResponse>.Tags(params string[])
    Endpoint<EmptyRequest, TResponse>.Throttle(int, double, string)
    Endpoint<EmptyRequest, TResponse>.Trace(params string[])
    Endpoint<EmptyRequest, TResponse>.Trace(string, Expression<Func<EmptyRequest, object>>)
    Endpoint<EmptyRequest, TResponse>.Validator<TValidator>()
    Endpoint<EmptyRequest, TResponse>.Verbs(params Http[])
    Endpoint<EmptyRequest, TResponse>.Verbs(params string[])
    Endpoint<EmptyRequest, TResponse>.Version(int, int)
    Endpoint<EmptyRequest, TResponse>.ValidationFailed
    Endpoint<EmptyRequest, TResponse>.AddError(ValidationFailure)
    Endpoint<EmptyRequest, TResponse>.AddError(string, string, Severity)
    Endpoint<EmptyRequest, TResponse>.AddError(Expression<Func<EmptyRequest, object>>, string, string, Severity)
    Endpoint<EmptyRequest, TResponse>.ThrowError(ValidationFailure, int?)
    Endpoint<EmptyRequest, TResponse>.ThrowError(string, int?)
    Endpoint<EmptyRequest, TResponse>.ThrowError(string, string, Severity, int?)
    Endpoint<EmptyRequest, TResponse>.ThrowError(Expression<Func<EmptyRequest, object>>, string, int?)
    Endpoint<EmptyRequest, TResponse>.ThrowError(Expression<Func<EmptyRequest, object>>, string, string, Severity, int?)
    Endpoint<EmptyRequest, TResponse>.ThrowIfAnyErrors(int?)
    BaseEndpoint.Definition
    BaseEndpoint.HttpContext
    BaseEndpoint.ValidationFailures
    BaseEndpoint.Configure()
    BaseEndpoint.Verbs(params string[])
    BaseEndpoint.Routes(params string[])
    BaseEndpoint.Group<TEndpointGroup>()
    BaseEndpoint.GetAclHash(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: FastEndpoints
    Assembly: FastEndpoints.dll
    Syntax
    public abstract class EndpointWithoutRequest<TResponse> : Endpoint<EmptyRequest, TResponse>, IEndpoint, IEventBus, IServiceResolverBase, INoRequest
    Type Parameters
    Name Description
    TResponse

    the type of the response dto

    Methods

    ExecuteAsync(EmptyRequest, CancellationToken)

    override the ExecuteAsync(CancellationToken ct) method instead of using this method!

    Declaration
    public override sealed Task<TResponse> ExecuteAsync(EmptyRequest _, CancellationToken ct)
    Parameters
    Type Name Description
    EmptyRequest _
    CancellationToken ct
    Returns
    Type Description
    Task<TResponse>
    Overrides
    Endpoint<EmptyRequest, TResponse>.ExecuteAsync(EmptyRequest, CancellationToken)

    ExecuteAsync(CancellationToken)

    the handler method for the endpoint that returns the response dto. this method is called for each request received.

    Declaration
    public virtual Task<TResponse> ExecuteAsync(CancellationToken ct)
    Parameters
    Type Name Description
    CancellationToken ct

    a cancellation token

    Returns
    Type Description
    Task<TResponse>

    HandleAsync(EmptyRequest, CancellationToken)

    override the HandleAsync(CancellationToken ct) method instead of using this method!

    Declaration
    public override sealed Task HandleAsync(EmptyRequest _, CancellationToken ct)
    Parameters
    Type Name Description
    EmptyRequest _
    CancellationToken ct
    Returns
    Type Description
    Task
    Overrides
    Endpoint<EmptyRequest, TResponse>.HandleAsync(EmptyRequest, CancellationToken)

    HandleAsync(CancellationToken)

    the handler method for the endpoint. this method is called for each request received.

    Declaration
    public virtual Task HandleAsync(CancellationToken ct)
    Parameters
    Type Name Description
    CancellationToken ct

    a cancellation token

    Returns
    Type Description
    Task

    Implements

    IEndpoint
    IEventBus
    IServiceResolverBase
    INoRequest
    In this article
    Back to top Developed by Đĵ ΝιΓΞΗΛψΚ and contributors / Licensed under MIT / Website generated by DocFX