Class FromHeaderAttribute

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

Inheritance

System.Object

System.Attribute

FromHeaderAttribute

Inherited Members

System.Attribute.Equals(System.Object)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetHashCode()

System.Attribute.IsDefaultAttribute()

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.Module, System.Type)

System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.Match(System.Object)

System.Attribute.TypeId

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: FastEndpoints

Assembly: FastEndpoints.Attributes.dll

Syntax

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
public class FromHeaderAttribute : Attribute

Constructors

FromHeaderAttribute(Boolean, Boolean)

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
System.Boolean	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.
System.Boolean	removeFromSchema	set to true if your header is not required but shouldn't be added to schema model.

FromHeaderAttribute(String, Boolean, Boolean)

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
System.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.
System.Boolean	isRequired	set to false if a validation error shouldn't be thrown when the current request doesn't have the specified header.
System.Boolean	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
System.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
System.Boolean

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
System.Boolean