Show / Hide Table of Contents

    Class HeaderCollection

    Inheritance
    Object
    HeaderCollection
    Implements
    IEnumerable<HttpHeader>
    IEnumerable
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Titanium.Web.Proxy.Http
    Assembly: Titanium.Web.Proxy.dll
    Syntax
    [TypeConverter(typeof(ExpandableObjectConverter))]
    public class HeaderCollection : IEnumerable<HttpHeader>, IEnumerable

    Constructors

    HeaderCollection()

    Initializes a new instance of the HeaderCollection class.

    Declaration
    public HeaderCollection()

    Properties

    Headers

    Unique Request header collection

    Declaration
    public ReadOnlyDictionary<string, HttpHeader> Headers { get; }
    Property Value
    Type Description
    ReadOnlyDictionary<String, HttpHeader>

    NonUniqueHeaders

    Non Unique headers

    Declaration
    public ReadOnlyDictionary<string, List<HttpHeader>> NonUniqueHeaders { get; }
    Property Value
    Type Description
    ReadOnlyDictionary<String, List<HttpHeader>>

    Methods

    AddHeader(String, String)

    Add a new header with given name and value

    Declaration
    public void AddHeader(string name, string value)
    Parameters
    Type Name Description
    String name
    String value

    AddHeader(HttpHeader)

    Adds the given header object to Request

    Declaration
    public void AddHeader(HttpHeader newHeader)
    Parameters
    Type Name Description
    HttpHeader newHeader

    AddHeaders(IEnumerable<KeyValuePair<String, String>>)

    Adds the given header objects to Request

    Declaration
    public void AddHeaders(IEnumerable<KeyValuePair<string, string>> newHeaders)
    Parameters
    Type Name Description
    IEnumerable<System.Collections.Generic.KeyValuePair<String, String>> newHeaders

    AddHeaders(IEnumerable<KeyValuePair<String, HttpHeader>>)

    Adds the given header objects to Request

    Declaration
    public void AddHeaders(IEnumerable<KeyValuePair<string, HttpHeader>> newHeaders)
    Parameters
    Type Name Description
    IEnumerable<System.Collections.Generic.KeyValuePair<String, HttpHeader>> newHeaders

    AddHeaders(IEnumerable<HttpHeader>)

    Adds the given header objects to Request

    Declaration
    public void AddHeaders(IEnumerable<HttpHeader> newHeaders)
    Parameters
    Type Name Description
    IEnumerable<HttpHeader> newHeaders

    Clear()

    Removes all the headers.

    Declaration
    public void Clear()

    GetAllHeaders()

    Returns all headers

    Declaration
    public List<HttpHeader> GetAllHeaders()
    Returns
    Type Description
    List<HttpHeader>

    GetEnumerator()

    Returns an enumerator that iterates through the collection.

    Declaration
    public IEnumerator<HttpHeader> GetEnumerator()
    Returns
    Type Description
    IEnumerator<HttpHeader>

    An enumerator that can be used to iterate through the collection.

    GetFirstHeader(String)

    Declaration
    public HttpHeader GetFirstHeader(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    HttpHeader

    GetHeaders(String)

    Returns all headers with given name if exists Returns null if does'nt exist

    Declaration
    public List<HttpHeader> GetHeaders(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    List<HttpHeader>

    HeaderExists(String)

    True if header exists

    Declaration
    public bool HeaderExists(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    Boolean

    RemoveHeader(String)

    removes all headers with given name

    Declaration
    public bool RemoveHeader(string headerName)
    Parameters
    Type Name Description
    String headerName
    Returns
    Type Description
    Boolean

    True if header was removed False if no header exists with given name

    RemoveHeader(HttpHeader)

    Removes given header object if it exist

    Declaration
    public bool RemoveHeader(HttpHeader header)
    Parameters
    Type Name Description
    HttpHeader header

    Returns true if header exists and was removed

    Returns
    Type Description
    Boolean

    Explicit Interface Implementations

    IEnumerable.GetEnumerator()

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type Description
    IEnumerator

    Implements

    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable
    Back to top Generated by DocFX