WarningHeaderValue Class

Represents the value of the Warning HTTP header.

Assembly: System.Net.Http.Formatting.dll

Syntax


public sealed class WarningHeaderValue

Remarks

The Warning header provides a way to indicate that the client, a proxy, or a gateway has made a modification to the message which is likely to be important to the user or another system.

The WarningHeaderValue class provides a convenient way to parse and construct Warning header values according to RFC 7234.

Constructors

WarningHeaderValue
(string agent, int code, string text)

Initializes a new instance of the WarningHeaderValue class with the specified agent, code, and text.

public WarningHeaderValue(string agent, int code, string text);
WarningHeaderValue
(string agent, int code, string text, DateTimeOffset date)

Initializes a new instance of the WarningHeaderValue class with the specified agent, code, text, and date.

public WarningHeaderValue(string agent, int code, string text, DateTimeOffset date);

Properties

Agent
public string Agent { get; }

Gets the agent that generated the warning.
Code
public int Code { get; }

Gets the warning code.
Date
public DateTimeOffset? Date { get; }

Gets the date and time the warning was generated.
Text
public string Text { get; }

Gets the warning text.

Methods

Equals
(object obj)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj);
GetHashCode
()

Serves as the default hash function.

public override int GetHashCode();
Parse
(string input)

Parses a Warning header value from the specified string.

public static WarningHeaderValue Parse(string input);
ToString
()

Returns a string representation of the current WarningHeaderValue object.

public override string ToString();
TryParse
(string input, out WarningHeaderValue result)

Tries to parse a Warning header value from the specified string.

public static bool TryParse(string input, out WarningHeaderValue result);

Example

The following example demonstrates how to create and add a WarningHeaderValue to an HTTP request.

            
using System;
using System.Net.Http;
using System.Net.Http.Headers;

public class Example
{
    public static void Main()
    {
        var client = new HttpClient();
        var request = new HttpRequestMessage(HttpMethod.Get, "http://example.com");

        // Create a WarningHeaderValue
        var warning = new WarningHeaderValue("my-agent", 110, "Response is stale");
        request.Headers.Warning.Add(warning);

        // You can also include a date
        var warningWithDate = new WarningHeaderValue("another-agent", 199, "Content modified", DateTimeOffset.UtcNow);
        request.Headers.Warning.Add(warningWithDate);

        // Send the request...
        // var response = await client.SendAsync(request);
        // Console.WriteLine(response);
    }
}
            
        