Search Results for

    Show / Hide Table of Contents

    Class FromHeaderAttribute

    properties decorated with this attribute will have their values auto bound from the relevant http header of the current request.

    Inheritance
    object
    Attribute
    FromHeaderAttribute
    Inherited Members
    Attribute.Equals(object)
    Attribute.GetCustomAttribute(Assembly, Type)
    Attribute.GetCustomAttribute(Assembly, Type, bool)
    Attribute.GetCustomAttribute(MemberInfo, Type)
    Attribute.GetCustomAttribute(MemberInfo, Type, bool)
    Attribute.GetCustomAttribute(Module, Type)
    Attribute.GetCustomAttribute(Module, Type, bool)
    Attribute.GetCustomAttribute(ParameterInfo, Type)
    Attribute.GetCustomAttribute(ParameterInfo, Type, bool)
    Attribute.GetCustomAttributes(Assembly)
    Attribute.GetCustomAttributes(Assembly, bool)
    Attribute.GetCustomAttributes(Assembly, Type)
    Attribute.GetCustomAttributes(Assembly, Type, bool)
    Attribute.GetCustomAttributes(MemberInfo)
    Attribute.GetCustomAttributes(MemberInfo, bool)
    Attribute.GetCustomAttributes(MemberInfo, Type)
    Attribute.GetCustomAttributes(MemberInfo, Type, bool)
    Attribute.GetCustomAttributes(Module)
    Attribute.GetCustomAttributes(Module, bool)
    Attribute.GetCustomAttributes(Module, Type)
    Attribute.GetCustomAttributes(Module, Type, bool)
    Attribute.GetCustomAttributes(ParameterInfo)
    Attribute.GetCustomAttributes(ParameterInfo, bool)
    Attribute.GetCustomAttributes(ParameterInfo, Type)
    Attribute.GetCustomAttributes(ParameterInfo, Type, bool)
    Attribute.GetHashCode()
    Attribute.IsDefaultAttribute()
    Attribute.IsDefined(Assembly, Type)
    Attribute.IsDefined(Assembly, Type, bool)
    Attribute.IsDefined(MemberInfo, Type)
    Attribute.IsDefined(MemberInfo, Type, bool)
    Attribute.IsDefined(Module, Type)
    Attribute.IsDefined(Module, Type, bool)
    Attribute.IsDefined(ParameterInfo, Type)
    Attribute.IsDefined(ParameterInfo, Type, bool)
    Attribute.Match(object)
    Attribute.TypeId
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: FastEndpoints
    Assembly: FastEndpoints.Attributes.dll
    Syntax
    [AttributeUsage(AttributeTargets.Property)]
    public sealed class FromHeaderAttribute : Attribute

    Constructors

    FromHeaderAttribute(bool, bool)

    properties decorated with this attribute will have their values auto bound from the relevant http header of the current request.

    Declaration
    public FromHeaderAttribute(bool isRequired, bool removeFromSchema = false)
    Parameters
    Type Name Description
    bool isRequired

    set to false if a validation error shouldn't be thrown when the current user request doesn't have a header matching the property name being bound to.

    bool removeFromSchema

    set to true if your header is not required but shouldn't be added to schema model.

    FromHeaderAttribute(string?, bool, bool)

    properties decorated with this attribute will have their values auto bound from the relevant http header of the current request.

    Declaration
    public FromHeaderAttribute(string? headerName = null, bool isRequired = true, bool removeFromSchema = false)
    Parameters
    Type Name Description
    string headerName

    optionally specify the header name to bind from. if not specified, the header name must match the name of the property being bound to.

    bool isRequired

    set to false if a validation error shouldn't be thrown when the current request doesn't have the specified header.

    bool removeFromSchema

    set to true if your header is not required but shouldn't be added to schema model.

    Properties

    HeaderName

    the header name to auto bind from

    Declaration
    public string? HeaderName { get; set; }
    Property Value
    Type Description
    string

    IsRequired

    set to true if a validation error should be thrown when the current request doesn't have the specified header

    Declaration
    public bool IsRequired { get; set; }
    Property Value
    Type Description
    bool

    RemoveFromSchema

    set to true if your header is not required but shouldn't be added to schema model

    Declaration
    public bool RemoveFromSchema { get; set; }
    Property Value
    Type Description
    bool
    In this article
    Back to top Developed by Đĵ ΝιΓΞΗΛψΚ and contributors / Licensed under MIT / Website generated by DocFX