Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

HttpMediaTypeWithQualityHeaderValueCollection class

Applies to Windows and Windows Phone

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

Syntax


public sealed class HttpMediaTypeWithQualityHeaderValueCollection : IList<HttpMediaTypeWithQualityHeaderValue>,
    IEnumerable<HttpMediaTypeWithQualityHeaderValue>,
    IStringable

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06030000)]

Members

The HttpMediaTypeWithQualityHeaderValueCollection class has these types of members:

Methods

The HttpMediaTypeWithQualityHeaderValueCollection class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
Add [C#, VB]Adds a new item to the end of the collection.
Append [C++, JavaScript]Adds a new HttpMediaTypeWithQualityHeaderValue item to the end of the collection.
Clear Removes all objects from the collection.
Contains [C#, VB]Determines whether an element is in the collection.
CopyTo [C#, VB]Copies the elements of the collection to an array, starting at a particular array index in the destination array.
First [C++, JavaScript]Retrieves an iterator to the first HttpMediaTypeWithQualityHeaderValue item in the collection.
GetAt [C++, JavaScript]Returns the HttpMediaTypeWithQualityHeaderValue at the specified index in the collection.
GetMany [C++, JavaScript]Retrieves the HttpMediaTypeWithQualityHeaderValue items that start at the specified index in the collection.
GetView [C++, JavaScript]Returns an immutable view of the HttpMediaTypeWithQualityHeaderValueCollection.
IndexOf [C++, JavaScript]Retrieves the index of an HttpMediaTypeWithQualityHeaderValue in the collection.
IndexOf [C#, VB]Determines the index of a specific item in the collection.
Insert [C#, VB]Inserts an item into the collection at the specified index.
InsertAt [C++, JavaScript]Inserts an HttpMediaTypeWithQualityHeaderValue into the collection at the specified index.
ParseAdd Parses and adds an entry to the HttpMediaTypeWithQualityHeaderValueCollection.
Remove [C#, VB]Removes a specific object from the collection.
RemoveAt [C++, JavaScript]Removes the entry at the specified index from the HttpMediaTypeWithQualityHeaderValueCollection.
RemoveAt [C#, VB]Removes the element at the specified index of the collection.
RemoveAtEnd [C++, JavaScript]Removes the last HttpMediaTypeWithQualityHeaderValue item from the collection.
ReplaceAll [C++, JavaScript]Replaces all the HttpMediaTypeWithQualityHeaderValue items in the collection with the specified HttpMediaTypeWithQualityHeaderValue items.
SetAt [C++, JavaScript]Sets the HttpMediaTypeWithQualityHeaderValue at the specified index in the collection.
ToString Returns a string that represents the current HttpMediaTypeWithQualityHeaderValueCollection object.
TryParseAdd Tries to parse and add the specified item to the HttpMediaTypeWithQualityHeaderValueCollection.

 

Properties

The HttpMediaTypeWithQualityHeaderValueCollection class has these properties.

PropertyAccess typeDescription

Count [C#, VB]

Read-onlyGets the number of elements that are contained in the collection.

IsReadOnly [C#, VB]

Read-onlyGets a value indicating whether the collection is read-only.

Item [C#, VB]

Read/writeGets or sets the element at the specified index.

Size [C++, JavaScript]

Read-onlyGets the number of HttpMediaTypeWithQualityHeaderValue objects in the collection.

 

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


Requirements

Minimum supported client

Windows 8.1 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Web.Http.Headers
Windows::Web::Http::Headers [C++]

Metadata

Windows.winmd

See also

Accept
HttpMediaTypeWithQualityHeaderValue
HttpRequestHeaderCollection
IIterable(HttpMediaTypeWithQualityHeaderValue)
IStringable
IVector(HttpMediaTypeWithQualityHeaderValue)
Object

 

 

Show:
© 2014 Microsoft