Search Results for

    Show / Hide Table of Contents

    Class EndpointWithoutRequest

    use this base class for defining endpoints that doesn't need a request dto. usually used for routes that doesn't have any parameters.

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

    Methods

    ExecuteAsync(EmptyRequest, CancellationToken)

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

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

    ExecuteAsync(CancellationToken)

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

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

    a cancellation token

    Returns
    Type Description
    Task<object>

    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, object>.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