Class TooManyRequestsObjectResult

Namespace

Cuemon.AspNetCore.Mvc

Assembly

Cuemon.AspNetCore.Mvc.dll

An ObjectResult that when executed will produce a Too Many Requests (429) response.

public class TooManyRequestsObjectResult : ObjectResult, IStatusCodeActionResult, IActionResult

Inheritance

object

ActionResult

ObjectResult

TooManyRequestsObjectResult

Implements

IStatusCodeActionResult

IActionResult

Inherited Members

ObjectResult.ExecuteResultAsync(ActionContext)

ObjectResult.OnFormatting(ActionContext)

ObjectResult.Value

ObjectResult.Formatters

ObjectResult.ContentTypes

ObjectResult.DeclaredType

ObjectResult.StatusCode

ActionResult.ExecuteResult(ActionContext)

Examples

The following example demonstrates how to return a with a descriptive error object to produce a 429 HTTP response.

using Cuemon.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc;

namespace MyApp.Examples;

public class RateLimitController : Controller
{
    [HttpGet("/api/rate-limited")]
    public IActionResult GetData()
    {
        return new TooManyRequestsObjectResult(new
        {
            error = "API rate limit exceeded. Please try again later.",
            retryAfter = 60
        });

}
}

Constructors

TooManyRequestsObjectResult(object)

Initializes a new instance of the TooManyRequestsObjectResult class.

public TooManyRequestsObjectResult(object error)

Parameters

error object

Contains the errors to be returned to the client.