HttpContentCodingWithQualityHeaderValueCollection Class

Definition

Namespace:

Windows.Web.Http.Headers

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

public ref class HttpContentCodingWithQualityHeaderValueCollection sealed : IIterable<HttpContentCodingWithQualityHeaderValue ^>, IVector<HttpContentCodingWithQualityHeaderValue ^>, IStringable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class HttpContentCodingWithQualityHeaderValueCollection final : IIterable<HttpContentCodingWithQualityHeaderValue>, IVector<HttpContentCodingWithQualityHeaderValue>, IStringable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class HttpContentCodingWithQualityHeaderValueCollection : IEnumerable<HttpContentCodingWithQualityHeaderValue>, IList<HttpContentCodingWithQualityHeaderValue>, IStringable

Public NotInheritable Class HttpContentCodingWithQualityHeaderValueCollection
Implements IEnumerable(Of HttpContentCodingWithQualityHeaderValue), IList(Of HttpContentCodingWithQualityHeaderValue), IStringable

Inheritance

Object Platform::Object IInspectable HttpContentCodingWithQualityHeaderValueCollection

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IIterable<T> IEnumerable<T> IIterable<HttpContentCodingWithQualityHeaderValue> IEnumerable<HttpContentCodingWithQualityHeaderValue> IVector<HttpContentCodingWithQualityHeaderValue> IList<HttpContentCodingWithQualityHeaderValue> IStringable

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

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

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

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

            // Set the header with a string.
            parsedOk = request.Headers.AcceptEncoding.TryParseAdd("compress");
            parsedOk = request.Headers.AcceptEncoding.TryParseAdd("gzip;q=1.0");

            // Set the header with a strong type.
            request.Headers.AcceptEncoding.Add(new HttpContentCodingWithQualityHeaderValue("*", 0));

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

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

Remarks

The HttpContentCodingWithQualityHeaderValueCollection class represents the value of the Accept-Encoding HTTP header on an HTTP request.

The HttpContentCodingWithQualityHeaderValueCollection provides a collection container for instances of the HttpContentCodingWithQualityHeaderValue class used for accept encoding information in the Accept-Encoding HTTP header.

The AcceptEncoding property on the HttpRequestHeaderCollection returns an HttpContentCodingWithQualityHeaderValueCollection object. This is the method used to construct an HttpContentCodingWithQualityHeaderValueCollection object.

Collection member lists

For JavaScript, HttpContentCodingWithQualityHeaderValueCollection has the members shown in the member lists. In addition, HttpContentCodingWithQualityHeaderValueCollection supports members of Array.prototype and using an index to access items.

Enumerating the collection in C# or Microsoft Visual Basic

You can iterate through an HttpContentCodingWithQualityHeaderValueCollection object in C# or Microsoft Visual Basic. In many cases, such as using foreach syntax, the compiler does this casting for you and you won't need to cast to IEnumerable<HttpContentCodingWithQualityHeaderValue> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast the collection object to IEnumerable<T> with an HttpContentCodingWithQualityHeaderValue constraint.

Properties

Size	Gets the number of HttpContentCodingWithQualityHeaderValue objects in the collection.

Methods

Append(HttpContentCodingWithQualityHeaderValue)	Adds a new HttpContentCodingWithQualityHeaderValue item to the end of the collection.
Clear()	Removes all objects from the collection.
First()	Retrieves an iterator to the first HttpContentCodingWithQualityHeaderValue item in the collection.
GetAt(UInt32)	Returns the HttpContentCodingWithQualityHeaderValue at the specified index in the collection.
GetMany(UInt32, HttpContentCodingWithQualityHeaderValue[])	Retrieves the HttpContentCodingWithQualityHeaderValue items that start at the specified index in the collection.
GetView()	Returns an immutable view of the HttpContentCodingWithQualityHeaderValueCollection.
IndexOf(HttpContentCodingWithQualityHeaderValue, UInt32)	Retrieves the index of an HttpContentCodingWithQualityHeaderValue in the collection.
InsertAt(UInt32, HttpContentCodingWithQualityHeaderValue)	Inserts an HttpContentCodingWithQualityHeaderValue into the collection at the specified index.
ParseAdd(String)	Parses and adds an entry to the HttpContentCodingWithQualityHeaderValueCollection.
RemoveAt(UInt32)	Removes the entry at the specified index from the HttpContentCodingWithQualityHeaderValueCollection.
RemoveAtEnd()	Removes the last HttpContentCodingWithQualityHeaderValue item from the collection.
ReplaceAll(HttpContentCodingWithQualityHeaderValue[])	Replaces all the HttpContentCodingWithQualityHeaderValue items in the collection with the specified HttpContentCodingWithQualityHeaderValue items.
SetAt(UInt32, HttpContentCodingWithQualityHeaderValue)	Sets the HttpContentCodingWithQualityHeaderValue at the specified index in the collection.
ToString()	Returns a string that represents the current HttpContentCodingWithQualityHeaderValueCollection object.
TryParseAdd(String)	Tries to parse and add the specified item to the HttpContentCodingWithQualityHeaderValueCollection.

See also

• AcceptEncoding
• HttpContentCodingWithQualityHeaderValue
• HttpRequestHeaderCollection
• HttpRequestMessage
• IIterable<T>
• IStringable
• IVector<T>