HeaderAttribute Class

Reference

Definition

Namespace:: Microsoft.Extensions.Http.AutoClient

Assembly:: Microsoft.Extensions.Http.AutoClient.dll

Package:: Microsoft.Extensions.Http.AutoClient v8.0.0-rc.2.23510.2

Source:: HeaderAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines a header to be used in the API request.

public ref class HeaderAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter)]
[System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")]
public sealed class HeaderAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter)>]
[<System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")>]
type HeaderAttribute = class
    inherit Attribute

Public NotInheritable Class HeaderAttribute
Inherits Attribute

Inheritance: Object

Attribute
HeaderAttribute

Attributes: AttributeUsageAttribute ConditionalAttribute

Examples

[AutoClient("MyClient")]
interface IMyDependencyClient
{
    [Get("/api/users")]
    Task<string> GetUsersAsync([Header("X-UserName")] string userName, CancellationToken cancellationToken);
}

Remarks

Marks a method parameter as a header to insert in the request.

Constructors

HeaderAttribute(String)

Initializes a new instance of the HeaderAttribute class.

Properties

Header

Gets the name of the header.

Applies to

Delen via