Http​Media​Type​With​Quality​Header​Value​Collection Http​Media​Type​With​Quality​Header​Value​Collection Http​Media​Type​With​Quality​Header​Value​Collection Class

Definition

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

public : sealed class HttpMediaTypeWithQualityHeaderValueCollection : IIterable, IVector, IStringable, IHttpMediaTypeWithQualityHeaderValueCollectionpublic sealed class HttpMediaTypeWithQualityHeaderValueCollection : IEnumerable, IList, IStringable, IHttpMediaTypeWithQualityHeaderValueCollectionPublic NotInheritable Class HttpMediaTypeWithQualityHeaderValueCollection Implements IEnumerable, IList, IStringable, IHttpMediaTypeWithQualityHeaderValueCollection
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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());
        }

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.

Properties

Item[Int32] Item[Int32] Item[Int32]

Gets or sets the element at the specified index.

This member is not implemented in C++T this[int index] { get; set; }Property Item(index As Integer) As T
Parameters
index

The zero-based index of the element to get or set.

Value
T T T

The element at the specified index.

Attributes
Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The property is set and the System.Collections.Generic.IList`1 is read-only.

Size Size Size

Gets the number of HttpMediaTypeWithQualityHeaderValue objects in the collection.

public : unsigned short Size { get; }This member is not implemented in C#This member is not implemented in VB.Net
Value
unsigned short uint uint

The number of HttpMediaTypeWithQualityHeaderValue objects in the HttpMediaTypeWithQualityHeaderValueCollection.

Attributes

Methods

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

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

public : void Append(HttpMediaTypeWithQualityHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
Attributes

Clear() Clear() Clear()

Removes all objects from the collection.

public : void Clear()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

First() First() First()

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

public : IIterator<HttpMediaTypeWithQualityHeaderValue> First()This member is not implemented in C#This member is not implemented in VB.Net
Returns
Attributes

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

Returns the HttpMediaTypeWithQualityHeaderValue at the specified index in the collection.

public : HttpMediaTypeWithQualityHeaderValue GetAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

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

Returns
Attributes

GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the collection.

This member is not implemented in C++IEnumerator<T> GetEnumerator()Function GetEnumerator As IEnumerator(Of T)
Returns

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

Attributes

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

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

public : unsigned short GetMany(unsigned int startIndex, HttpMediaTypeWithQualityHeaderValue[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
startIndex
unsigned int UInt32 UInt32

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

items
HttpMediaTypeWithQualityHeaderValue[] HttpMediaTypeWithQualityHeaderValue[] HttpMediaTypeWithQualityHeaderValue[]

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

Returns
unsigned short uint uint

The number of items retrieved.

Attributes

GetView() GetView() GetView()

Returns an immutable view of the HttpMediaTypeWithQualityHeaderValueCollection.

public : IVectorView<HttpMediaTypeWithQualityHeaderValue> GetView()This member is not implemented in C#This member is not implemented in VB.Net
Returns
IVectorView<HttpMediaTypeWithQualityHeaderValue> IReadOnlyList<HttpMediaTypeWithQualityHeaderValue> IReadOnlyList<HttpMediaTypeWithQualityHeaderValue>

The view of the HttpMediaTypeWithQualityHeaderValueCollection.

Attributes

IndexOf(T) IndexOf(T) IndexOf(T)

Determines the index of a specific item in the System.Collections.Generic.IList`1.

This member is not implemented in C++int IndexOf(T item)Function IndexOf(item As T) As Integer
Parameters
item
T T T

The object to locate in the System.Collections.Generic.IList`1.

Returns

The index of item if found in the list; otherwise, -1.

Attributes

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

Retrieves the index of an HttpMediaTypeWithQualityHeaderValue in the collection.

public : PlatForm::Boolean IndexOf(HttpMediaTypeWithQualityHeaderValue value, unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 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
PlatForm::Boolean bool bool

Indicates whether the item is found.

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

Attributes

Insert(Int32, T) Insert(Int32, T) Insert(Int32, T)

Inserts an item to the System.Collections.Generic.IList`1 at the specified index.

This member is not implemented in C++void Insert(int index, T item)Sub Insert(index As Integer, item As T)
Parameters
index

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

item
T T T

The object to insert into the System.Collections.Generic.IList`1.

Attributes
Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The System.Collections.Generic.IList`1 is read-only.

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

Inserts an HttpMediaTypeWithQualityHeaderValue into the collection at the specified index.

public : void InsertAt(unsigned int index, HttpMediaTypeWithQualityHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

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

Attributes

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

Parses and adds an entry to the HttpMediaTypeWithQualityHeaderValueCollection.

public : void ParseAdd(PlatForm::String input)public void ParseAdd(String input)Public Function ParseAdd(input As String) As void
Parameters
input
PlatForm::String String String

The entry to add.

Attributes

Remarks

Below are the exceptions that this function throws.

E_INVALIDARG

The input parameter is null (Nothing in Visual Basic).

The input parameter is not a valid value for the Accept HTTP header.

RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32)

Removes the System.Collections.Generic.IList`1 item at the specified index.

This member is not implemented in C++void RemoveAt(int index)Sub RemoveAt(index As Integer)
Parameters
index

The zero-based index of the item to remove.

Attributes
Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The System.Collections.Generic.IList`1 is read-only.

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

Removes the entry at the specified index from the HttpMediaTypeWithQualityHeaderValueCollection.

public : void RemoveAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The index of the entry to remove.

Attributes

RemoveAtEnd() RemoveAtEnd() RemoveAtEnd()

Removes the last HttpMediaTypeWithQualityHeaderValue item from the collection.

public : void RemoveAtEnd()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

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

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

public : void ReplaceAll(HttpMediaTypeWithQualityHeaderValue[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
items
HttpMediaTypeWithQualityHeaderValue[] HttpMediaTypeWithQualityHeaderValue[] HttpMediaTypeWithQualityHeaderValue[]

The HttpMediaTypeWithQualityHeaderValue items to add to the collection.

Attributes

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

Sets the HttpMediaTypeWithQualityHeaderValue at the specified index in the collection.

public : void SetAt(unsigned int index, HttpMediaTypeWithQualityHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

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

Attributes

ToString() ToString() ToString()

Returns a string that represents the current HttpMediaTypeWithQualityHeaderValueCollection object.

public : PlatForm::String ToString()public string ToString()Public Function ToString() As string
Returns
PlatForm::String string string

A string that represents the current object.

Attributes

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

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

public : PlatForm::Boolean TryParseAdd(PlatForm::String input)public bool TryParseAdd(String input)Public Function TryParseAdd(input As String) As bool
Parameters
input
PlatForm::String String String

The item to parse and add.

Returns
PlatForm::Boolean bool bool

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

Attributes

See Also