HttpMediaTypeWithQualityHeaderValueCollection HttpMediaTypeWithQualityHeaderValueCollection HttpMediaTypeWithQualityHeaderValueCollection HttpMediaTypeWithQualityHeaderValueCollection Class

Definition

Represents the value of the Accept HTTP header on an HTTP request.

public sealed class HttpMediaTypeWithQualityHeaderValueCollectionpublic sealed class HttpMediaTypeWithQualityHeaderValueCollectionPublic NotInheritable Class HttpMediaTypeWithQualityHeaderValueCollectionpublic sealed class HttpMediaTypeWithQualityHeaderValueCollection
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The HttpMediaTypeWithQualityHeaderValueCollection represents the value of the Accept HTTP header on an HTTP request.

The HttpMediaTypeWithQualityHeaderValueCollection is a collection of HttpMediaTypeWithQualityHeaderValue objects used for accept information in the HTTP Accept header.

The Accept property on the HttpRequestHeaderCollection returns an HttpMediaTypeWithQualityHeaderValueCollection object.

Examples

The following sample code shows a method to get and set the Accept HTTP header on an HttpRequestMessage object using the properties and methods on the HttpMediaTypeWithQualityHeaderValueCollection and HttpMediaTypeWithQualityHeaderValue classes.

using System;
using Windows.Web.Http;
using Windows.Web.Http.Headers;

        public void DemonstrateHeaderRequestAccept()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.Accept.TryParseAdd ("audio/*");
            parsedOk = request.Headers.Accept.TryParseAdd ("audio/*; q=0.2");
            parsedOk = request.Headers.Accept.TryParseAdd ("audio/*; q=0.4; mysetting=myvalue");

            // Set the header with a strong type.
            request.Headers.Accept.Add(new HttpMediaTypeWithQualityHeaderValue("audio/*", .6));

            // Get the strong type out
            foreach (var value in request.Headers.Accept)
            {
                System.Diagnostics.Debug.WriteLine("One of the Accept values: {0}={1}", value.MediaType, value.Quality);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The Accept ToString() results: {0}", request.Headers.Accept.ToString());
        }

Properties

Size Size Size Size

Gets the number of HttpMediaTypeWithQualityHeaderValue objects in the collection.

public uint Size { get; }public uint Size { get; }Public ReadOnly Property Size As uintpublic uint Size { get; }
Value
uint uint uint uint

The number of HttpMediaTypeWithQualityHeaderValue objects in the HttpMediaTypeWithQualityHeaderValueCollection.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Methods

Append(HttpMediaTypeWithQualityHeaderValue) Append(HttpMediaTypeWithQualityHeaderValue) Append(HttpMediaTypeWithQualityHeaderValue) Append(HttpMediaTypeWithQualityHeaderValue)

Adds a new HttpMediaTypeWithQualityHeaderValue item to the end of the collection.

public void Append(HttpMediaTypeWithQualityHeaderValue value)public void Append(HttpMediaTypeWithQualityHeaderValue value)Public Function Append(value As HttpMediaTypeWithQualityHeaderValue) As voidpublic void Append(HttpMediaTypeWithQualityHeaderValue value)
Parameters
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Clear() Clear() Clear() Clear()

Removes all objects from the collection.

public void Clear()public void Clear()Public Function Clear() As voidpublic void Clear()
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

First() First() First() First()

Retrieves an iterator to the first HttpMediaTypeWithQualityHeaderValue item in the collection.

public IIterator<HttpMediaTypeWithQualityHeaderValue> First()public IIterator<HttpMediaTypeWithQualityHeaderValue> First()Public Function First() As IIterator( Of HttpMediaTypeWithQualityHeaderValue )public IIterator<HttpMediaTypeWithQualityHeaderValue> First()
Returns

An object that can be used to enumerate the HttpMediaTypeWithQualityHeaderValue items in the collection. The iterator points to the first HttpMediaTypeWithQualityHeaderValue item in the HttpMediaTypeWithQualityHeaderValueCollection.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetAt(UInt32) GetAt(UInt32) GetAt(UInt32) GetAt(UInt32)

Returns the HttpMediaTypeWithQualityHeaderValue at the specified index in the collection.

public HttpMediaTypeWithQualityHeaderValue GetAt(UInt32 index)public HttpMediaTypeWithQualityHeaderValue GetAt(UInt32 index)Public Function GetAt(index As UInt32) As HttpMediaTypeWithQualityHeaderValuepublic HttpMediaTypeWithQualityHeaderValue GetAt(UInt32 index)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index of a specified item in the collection.

Returns
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetMany(UInt32, HttpMediaTypeWithQualityHeaderValue[]) GetMany(UInt32, HttpMediaTypeWithQualityHeaderValue[]) GetMany(UInt32, HttpMediaTypeWithQualityHeaderValue[]) GetMany(UInt32, HttpMediaTypeWithQualityHeaderValue[])

Retrieves the HttpMediaTypeWithQualityHeaderValue items that start at the specified index in the collection.

public uint GetMany(UInt32 startIndex, HttpMediaTypeWithQualityHeaderValue[] items)public uint GetMany(UInt32 startIndex, HttpMediaTypeWithQualityHeaderValue[] items)Public Function GetMany(startIndex As UInt32, items As HttpMediaTypeWithQualityHeaderValue[]) As uintpublic uint GetMany(UInt32 startIndex, HttpMediaTypeWithQualityHeaderValue[] items)
Parameters
startIndex
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index of the start of the HttpMediaTypeWithQualityHeaderValue items in the HttpMediaTypeWithQualityHeaderValueCollection.

items
Windows.Web.Http.Headers.HttpMediaTypeWithQualityHeaderValue[] Windows.Web.Http.Headers.HttpMediaTypeWithQualityHeaderValue[] Windows.Web.Http.Headers.HttpMediaTypeWithQualityHeaderValue[] Windows.Web.Http.Headers.HttpMediaTypeWithQualityHeaderValue[]

An array of HttpMediaTypeWithQualityHeaderValue items that start at startIndex in the HttpMediaTypeWithQualityHeaderValueCollection.

Returns
uint uint uint uint

The number of items retrieved.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GetView() GetView() GetView() GetView()

Returns an immutable view of the HttpMediaTypeWithQualityHeaderValueCollection.

public IVectorView<HttpMediaTypeWithQualityHeaderValue> GetView()public IVectorView<HttpMediaTypeWithQualityHeaderValue> GetView()Public Function GetView() As IVectorView( Of HttpMediaTypeWithQualityHeaderValue )public IVectorView<HttpMediaTypeWithQualityHeaderValue> GetView()
Returns
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

IndexOf(HttpMediaTypeWithQualityHeaderValue, UInt32) IndexOf(HttpMediaTypeWithQualityHeaderValue, UInt32) IndexOf(HttpMediaTypeWithQualityHeaderValue, UInt32) IndexOf(HttpMediaTypeWithQualityHeaderValue, UInt32)

Retrieves the index of an HttpMediaTypeWithQualityHeaderValue in the collection.

public bool IndexOf(HttpMediaTypeWithQualityHeaderValue value, UInt32 index)public bool IndexOf(HttpMediaTypeWithQualityHeaderValue value, UInt32 index)Public Function IndexOf(value As HttpMediaTypeWithQualityHeaderValue, index As UInt32) As boolpublic bool IndexOf(HttpMediaTypeWithQualityHeaderValue value, UInt32 index)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The index of the HttpMediaTypeWithQualityHeaderValue in the HttpMediaTypeWithQualityHeaderValueCollection.

If the item is found, this is the zero-based index of the item; otherwise, this parameter is 0.

Returns
bool bool bool bool

Indicates whether the item is found.

true if the HttpMediaTypeWithQualityHeaderValue item is found; otherwise, false.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

InsertAt(UInt32, HttpMediaTypeWithQualityHeaderValue) InsertAt(UInt32, HttpMediaTypeWithQualityHeaderValue) InsertAt(UInt32, HttpMediaTypeWithQualityHeaderValue) InsertAt(UInt32, HttpMediaTypeWithQualityHeaderValue)

Inserts an HttpMediaTypeWithQualityHeaderValue into the collection at the specified index.

public void InsertAt(UInt32 index, HttpMediaTypeWithQualityHeaderValue value)public void InsertAt(UInt32 index, HttpMediaTypeWithQualityHeaderValue value)Public Function InsertAt(index As UInt32, value As HttpMediaTypeWithQualityHeaderValue) As voidpublic void InsertAt(UInt32 index, HttpMediaTypeWithQualityHeaderValue value)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index at which value should be inserted.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

ParseAdd(String) ParseAdd(String) ParseAdd(String) ParseAdd(String)

Parses and adds an entry to the HttpMediaTypeWithQualityHeaderValueCollection.

public void ParseAdd(String input)public void ParseAdd(String input)Public Function ParseAdd(input As String) As voidpublic void ParseAdd(String input)
Parameters
input
System.String System.String System.String System.String

The entry to add.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32)

Removes the entry at the specified index from the HttpMediaTypeWithQualityHeaderValueCollection.

public void RemoveAt(UInt32 index)public void RemoveAt(UInt32 index)Public Function RemoveAt(index As UInt32) As voidpublic void RemoveAt(UInt32 index)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The index of the entry to remove.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

RemoveAtEnd() RemoveAtEnd() RemoveAtEnd() RemoveAtEnd()

Removes the last HttpMediaTypeWithQualityHeaderValue item from the collection.

public void RemoveAtEnd()public void RemoveAtEnd()Public Function RemoveAtEnd() As voidpublic void RemoveAtEnd()
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

ReplaceAll(HttpMediaTypeWithQualityHeaderValue[]) ReplaceAll(HttpMediaTypeWithQualityHeaderValue[]) ReplaceAll(HttpMediaTypeWithQualityHeaderValue[]) ReplaceAll(HttpMediaTypeWithQualityHeaderValue[])

Replaces all the HttpMediaTypeWithQualityHeaderValue items in the collection with the specified HttpMediaTypeWithQualityHeaderValue items.

public void ReplaceAll(HttpMediaTypeWithQualityHeaderValue[] items)public void ReplaceAll(HttpMediaTypeWithQualityHeaderValue[] items)Public Function ReplaceAll(items As HttpMediaTypeWithQualityHeaderValue[]) As voidpublic void ReplaceAll(HttpMediaTypeWithQualityHeaderValue[] items)
Parameters
items
Windows.Web.Http.Headers.HttpMediaTypeWithQualityHeaderValue[] Windows.Web.Http.Headers.HttpMediaTypeWithQualityHeaderValue[] Windows.Web.Http.Headers.HttpMediaTypeWithQualityHeaderValue[] Windows.Web.Http.Headers.HttpMediaTypeWithQualityHeaderValue[]

The HttpMediaTypeWithQualityHeaderValue items to add to the collection.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetAt(UInt32, HttpMediaTypeWithQualityHeaderValue) SetAt(UInt32, HttpMediaTypeWithQualityHeaderValue) SetAt(UInt32, HttpMediaTypeWithQualityHeaderValue) SetAt(UInt32, HttpMediaTypeWithQualityHeaderValue)

Sets the HttpMediaTypeWithQualityHeaderValue at the specified index in the collection.

public void SetAt(UInt32 index, HttpMediaTypeWithQualityHeaderValue value)public void SetAt(UInt32 index, HttpMediaTypeWithQualityHeaderValue value)Public Function SetAt(index As UInt32, value As HttpMediaTypeWithQualityHeaderValue) As voidpublic void SetAt(UInt32 index, HttpMediaTypeWithQualityHeaderValue value)
Parameters
index
System.UInt32 System.UInt32 System.UInt32 System.UInt32

The zero-based index at which to set the HttpMediaTypeWithQualityHeaderValue.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

ToString() ToString() ToString() ToString()

Returns a string that represents the current HttpMediaTypeWithQualityHeaderValueCollection object.

public string ToString()public string ToString()Public Function ToString() As stringpublic string ToString()
Returns
string string string string

A string that represents the current object.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

TryParseAdd(String) TryParseAdd(String) TryParseAdd(String) TryParseAdd(String)

Tries to parse and add the specified item to the HttpMediaTypeWithQualityHeaderValueCollection.

public bool TryParseAdd(String input)public bool TryParseAdd(String input)Public Function TryParseAdd(input As String) As boolpublic bool TryParseAdd(String input)
Parameters
input
System.String System.String System.String System.String

The item to parse and add.

Returns
bool bool bool bool

true if the item successfully parsed and was added; otherwise false.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)