HttpRequestHeaderCollection Kelas

Definisi

Ruang nama:

Windows.Web.Http.Headers

Menyediakan kumpulan header HTTP yang terkait dengan permintaan HTTP.

public ref class HttpRequestHeaderCollection sealed : IIterable<IKeyValuePair<Platform::String ^, Platform::String ^> ^>, IMap<Platform::String ^, Platform::String ^>, IStringable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class HttpRequestHeaderCollection final : IIterable<IKeyValuePair<winrt::hstring, winrt::hstring const&>>, IMap<winrt::hstring, winrt::hstring const&>, IStringable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class HttpRequestHeaderCollection : IDictionary<string,string>, IEnumerable<KeyValuePair<string,string>>, IStringable

Public NotInheritable Class HttpRequestHeaderCollection
Implements IDictionary(Of String, String), IEnumerable(Of KeyValuePair(Of String, String)), IStringable

Warisan

Object Platform::Object IInspectable HttpRequestHeaderCollection

Atribut

ContractVersionAttribute MarshalingBehaviorAttribute

Penerapan

IDictionary<String,String> IMap<Platform::String,Platform::String> IMap<winrt::hstring,winrt::hstring> IIterable<IKeyValuePair<K,V>> IEnumerable<KeyValuePair<K,V>> IEnumerable<KeyValuePair<String,String>> IIterable<IKeyValuePair<Platform::String,Platform::String>> IIterable<IKeyValuePair<winrt::hstring,winrt::hstring>> IStringable

Persyaratan Windows

Rangkaian perangkat	Windows 10 (diperkenalkan dalam 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (diperkenalkan dalam v1.0)

Contoh

Contoh kode berikut menunjukkan metode untuk mendapatkan dan mengatur header permintaan pada objek HttpRequestMessage menggunakan properti pada objek HttpRequestHeaderCollection. Namespace layanan Windows.Web.Http.Headers juga memiliki sejumlah koleksi header dan kelas nilai yang sangat ditik untuk header HTTP tertentu yang dapat digunakan untuk mendapatkan dan mengatur header dengan validasi.

using System;
using System.Collections.Generic;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.Web.Http;
using Windows.Web.Http.Headers;

        public void DemonstrateHeaderRequest()
        {
            DemonstrateHeaderRequestAccept();
            DemonstrateHeaderRequestAcceptEncoding();
            DemonstrateHeaderRequestAcceptLanguage();
            DemonstrateHeaderRequestAuthorization();
            DemonstrateHeaderRequestCacheControl();
            DemonstrateHeaderRequestConnection();
            DemonstrateHeaderRequestCookie();
            DemonstrateHeaderRequestDate();
            DemonstrateHeaderRequestFrom();
            DemonstrateHeaderRequestHost();
            DemonstrateHeaderRequestIfModifiedSince();
            DemonstrateHeaderRequestIfUnmodifiedSince();
            DemonstrateHeaderRequestMaxForwards();
            DemonstrateHeaderRequestProxyAuthorization();
            DemonstrateHeaderRequestReferer();
            DemonstrateHeaderRequestUserAgent();
        }

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

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

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

            // Set the header with a string.
            parsedOk = request.Headers.AcceptLanguage.TryParseAdd("da");
            parsedOk = request.Headers.AcceptLanguage.TryParseAdd("en-gb;q=0.8");

            // Set the header with a strong type.
            request.Headers.AcceptLanguage.Add(new HttpLanguageRangeWithQualityHeaderValue("en", .7));

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

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

        public void DemonstrateHeaderRequestAuthorization()
        {
            var request = new HttpRequestMessage();

            // Set the header with a strong type.
            string username = "user";
            string password = "password";
            var buffer = Windows.Security.Cryptography.CryptographicBuffer.ConvertStringToBinary (username + ":" + password, Windows.Security.Cryptography.BinaryStringEncoding.Utf8);
            string base64token = Windows.Security.Cryptography.CryptographicBuffer.EncodeToBase64String(buffer);
            request.Headers.Authorization = new HttpCredentialsHeaderValue("Basic", base64token);


            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("One of the Authorization values: {0}={1}", 
                request.Headers.Authorization.Scheme,
                request.Headers.Authorization.Token);

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

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

            // Set the header with a string.
            parsedOk = request.Headers.CacheControl.TryParseAdd("no-store");

            // Set the header with a strong type.
            request.Headers.CacheControl.Add(new HttpNameValueHeaderValue("max-age", "10"));

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

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


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

            // Set the header with a string.
            parsedOk = request.Headers.Connection.TryParseAdd("close");

            // Set the header with a strong type.
            request.Headers.Connection.Add(new HttpConnectionOptionHeaderValue("cache-control"));

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

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

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

            // Set the header with a string.
            parsedOk = request.Headers.Cookie.TryParseAdd("cookieName=cookieValue");

            // Set the header with a strong type.
            request.Headers.Cookie.Add(new HttpCookiePairHeaderValue("cookie2", "value2"));

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

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


        public void DemonstrateHeaderRequestDate()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            DateTimeOffset value = DateTimeOffset.UtcNow;
            request.Headers.Date = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("Date value in ticks: {0}", request.Headers.Date.Value.Ticks);

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

        public void DemonstrateHeaderRequestFrom()
        {
            var request = new HttpRequestMessage();

            // Set the header with a string.
            request.Headers.From = "person@example.com";

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("From value: {0}", request.Headers.From);
        }

        public void DemonstrateHeaderRequestHost()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            // HostName is in the Windows.Networking namespace.
            var value = new Windows.Networking.HostName("example.com");
            request.Headers.Host = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("Canonical Host name: {0}", request.Headers.Host.CanonicalName);

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

        public void DemonstrateHeaderRequestIfModifiedSince()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            var value = DateTimeOffset.Now.AddDays(-1); // Since yesterday.
            request.Headers.IfModifiedSince = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("IfModifiedSince value in ticks: {0}", request.Headers.IfModifiedSince.Value.Ticks);

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

        public void DemonstrateHeaderRequestIfUnmodifiedSince()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            var value = DateTimeOffset.Now.AddDays(-1); // Since yesterday.
            request.Headers.IfUnmodifiedSince = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("IfUnmodifiedSince value in ticks: {0}", request.Headers.IfUnmodifiedSince.Value.Ticks);

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

        public void DemonstrateHeaderRequestMaxForwards()
        {
            var request = new HttpRequestMessage();

            // Set the header with an integer.
            request.Headers.MaxForwards= 2;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("MaxForwards value: {0}", request.Headers.MaxForwards);
        }

        public void DemonstrateHeaderRequestProxyAuthorization()
        {
            var request = new HttpRequestMessage();

            // Set the header with a strong type.
            string username = "user";
            string password = "password";
            var buffer = Windows.Security.Cryptography.CryptographicBuffer.ConvertStringToBinary(username + ":" + password, Windows.Security.Cryptography.BinaryStringEncoding.Utf16LE);
            string base64token = Windows.Security.Cryptography.CryptographicBuffer.EncodeToBase64String(buffer);
            request.Headers.ProxyAuthorization = new HttpCredentialsHeaderValue("Basic", base64token);


            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("One of the ProxyAuthorixation values: {0}={1}",
                request.Headers.ProxyAuthorization.Scheme,
                request.Headers.ProxyAuthorization.Token);

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


        public void DemonstrateHeaderRequestReferer()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            // Uri is either in the Windows.Foundation namespace (JavaScript and C++)
            // or in the System.Net namespace (C#).
            var value = new Uri("http://example.com/");
            request.Headers.Referer = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("Referer absolute uri: {0}", request.Headers.Referer.AbsoluteUri);

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

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

            // Set the header with a string.
            parsedOk = request.Headers.UserAgent.TryParseAdd("testprogram/1.0");

            // Set the header with a strong type.
            request.Headers.UserAgent.Add(new HttpProductInfoHeaderValue("myprogram", "2.2"));

            // Get the strong type out
            foreach (var value in request.Headers.UserAgent)
            {
                System.Diagnostics.Debug.WriteLine("One of the UserAgent values: {0} / {1}", value.Product.Name, value.Product.Version);
            }

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

Keterangan

HttpRequestHeaderCollection adalah kumpulan header HTTP yang terkait dengan permintaan HTTP. Objek HttpRequestHeaderCollection dapat digunakan untuk mendapatkan atau mengatur header tertentu pada permintaan HTTP. Sebagian besar properti pada objek HttpRequestHeaderCollection menyediakan akses ke nilai header HTTP tertentu.

Properti Header diHttpRequestMessage mengembalikan objek HttpRequestHeaderCollection. Properti DefaultRequestHeaders di HttpClient juga mengembalikan objek HttpRequestHeaderCollection. Ini adalah dua metode untuk membangun objek HttpRequestHeaderCollection.

HttpRequestHeaderCollection mewakili header HTTP pada permintaan HTTP yang dapat diatur pengembang aplikasi, bukan semua header yang akhirnya dapat dikirim dengan permintaan. HttpBaseProtocolFilter akan menambahkan beberapa header tambahan.

Header pada permintaan HTTP dapat diubah oleh tumpukan yang mendasar. Inilah sebabnya mengapa aplikasi mungkin ingin mendapatkan nilai header dari HttpRequestHeaderCollection setelah permintaan selesai.

Menghitung koleksi di C# atau Microsoft Visual Basic

Anda dapat melakukan iterasi melalui objek HttpRequestHeaderCollection di C# atau Microsoft Visual Basic. Dalam banyak kasus, seperti menggunakan sintaks foreach , pengkompilasi melakukan transmisi ini untuk Anda dan Anda tidak perlu mentransmisikan secara IEnumerable eksplisit. Jika Anda perlu mentransmisikan secara eksplisit, misalnya jika Anda ingin memanggil GetEnumerator, transmisikan objek koleksi ke IEnumerable<T> dengan KeyValuePair dari String dan String sebagai batasan.

Properti

Accept	Mendapatkan objek HttpMediaTypeWithQualityHeaderValueCollection dari objek HttpMediaTypeWithQualityHeaderValue yang mewakili nilai header HTTP Accept pada permintaan HTTP.
AcceptEncoding	Mendapatkan objek HttpContentCodingWithQualityHeaderValueCollection dari objek HttpContentCodingWithQualityHeaderValue yang mewakili nilai header HTTP Accept-Encoding pada permintaan HTTP.
AcceptLanguage	Mendapatkan objek HttpLanguageRangeWithQualityHeaderValueCollection dari objek HttpLanguageRangeWithQualityHeaderValue yang mewakili nilai header HTTP Accept-Language pada permintaan HTTP.
Authorization	Mendapatkan atau mengatur objek HttpCredentialsHeaderValue yang mewakili nilai header HTTP Otorisasi pada permintaan HTTP.
CacheControl	Mendapatkan HttpCacheDirectiveHeaderValueCollection yang mewakili nilai header HTTP Cache-Control pada permintaan HTTP.
Connection	Mendapatkan objek HttpConnectionOptionHeaderValueCollection dari HttpConnectionOptionHeaderValue yang mewakili nilai header HTTP Koneksi pada permintaan HTTP.
Cookie	Mendapatkan objek HttpCookiePairHeaderValueCollection dari objek HttpCookiePairHeaderValue yang mewakili nilai header HTTP Cookie yang dikirim pada permintaan HTTP.
Date	Mendapatkan atau mengatur objek DateTime yang mewakili nilai header HTTP Tanggal pada permintaan HTTP.
Expect	Mendapatkan objek HttpExpectationHeaderValueCollection dari HttpExpectationHeaderValue yang mewakili nilai header Http Expect pada permintaan HTTP.
From	Mendapatkan atau mengatur String yang mewakili nilai header Dari HTTP pada permintaan HTTP.
Host	Mendapatkan atau mengatur HostName yang mewakili nilai header HTTP Host pada permintaan HTTP.
IfModifiedSince	Mendapatkan atau mengatur objek DateTime yang mewakili nilai header HTTP If-Modified-Since pada permintaan HTTP.
IfUnmodifiedSince	Mendapatkan atau mengatur objek DateTime yang mewakili nilai header HTTP If-Unmodified-Since pada permintaan HTTP.
MaxForwards	Mendapatkan atau menetapkan nilai bilangan bulat yang mewakili nilai header HTTP Max-Forwards pada permintaan HTTP.
ProxyAuthorization	Mendapatkan atau mengatur objek HttpCredentialsHeaderValue yang mewakili nilai header HTTP Proxy-Authorization pada permintaan HTTP.
Referer	Mendapatkan atau mengatur Uri yang mewakili nilai header HTTP Referer pada permintaan HTTP.
Size	Mendapatkan jumlah objek di HttpRequestHeaderCollection.
TransferEncoding	Mendapatkan objek HttpTransferCodingHeaderValueCollection dari objek HttpTransferCodingHeaderValue yang mewakili nilai header HTTP Transfer-Encoding pada permintaan HTTP.
UserAgent	Mendapatkan objek HttpProductInfoHeaderValueCollection dari objek HttpProductInfoHeaderValue yang mewakili nilai header HTTP User-Agent pada permintaan HTTP.

Metode

Append(String, String)	Menambahkan item baru ke akhir HttpRequestHeaderCollection.
Clear()	Menghapus semua objek dari HttpRequestHeaderCollection.
First()	Mengambil iterator ke item pertama di HttpRequestHeaderCollection.
GetView()	Mengembalikan tampilan httpRequestHeaderCollection yang tidak dapat diubah.
HasKey(String)	Menentukan apakah HttpRequestHeaderCollection berisi kunci yang ditentukan.
Insert(String, String)	Menyisipkan atau mengganti item di HttpRequestHeaderCollection dengan kunci dan nilai yang ditentukan.
Lookup(String)	Menemukan item di HttpRequestHeaderCollection jika ada.
Remove(String)	Menghapus objek tertentu dari HttpRequestHeaderCollection.
ToString()	Mengembalikan string yang mewakili objek HttpRequestHeaderCollection saat ini.
TryAppendWithoutValidation(String, String)	Cobalah untuk menambahkan item yang ditentukan ke HttpRequestHeaderCollection tanpa validasi.

Lihat juga

• DefaultRequestHeaders
• Headers
• HttpBaseProtocolFilter
• HttpClient
• HttpRequestMessage
• IMap<K,V>
• IIterable<T>
• IStringable