Класс HttpHeaders
Заголовки для HTTP-запросов и ответов.
В некоторых ситуациях заголовки являются неизменяемыми:
-
HttpRequest и HttpClientResponse всегда имеют неизменяемые заголовки.
-
HttpResponse и HttpClientRequest имеют неизменяемые заголовки с момента записи тела.
В этих ситуациях методы изменения заголовков выбрасывают исключения.
Для всех операций с HTTP-заголовками имя заголовка регистронезависимо.
Чтобы установить значение заголовка, используйте метод set().
request.headers.set(HttpHeaders.cacheControlHeader,
'max-age=3600, must-revalidate'); Чтобы получить значение заголовка, используйте метод value().
print(request.headers.value(HttpHeaders.userAgentHeader));
Объект HttpHeaders содержит список значений для каждого имени, как это разрешено стандартом. В большинстве случаев имя содержит только одно значение. Наиболее распространенный способ работы - использовать set() для установки значения и value() для получения значения.
Конструкторы
- HttpHeaders()
Свойства
- chunkedTransferEncoding ↔ bool чтение / запись
- Указывает, использует ли соединение кодирование блоками.
- contentLength ↔ int чтение / запись
- Значение заголовка contentLengthHeader, если он существует.
- contentType ↔ ContentType? чтение / запись
- Тип содержимого ContentType заголовка contentTypeHeader, если он существует.
- date ↔ DateTime? чтение / запись
- Дата, указанная в заголовке dateHeader, если он существует.
- expires ↔ DateTime? чтение / запись
- Дата и время, указанные в заголовке expiresHeader, если он существует.
- hashCode → int только для чтения, унаследовано
- Код хэша этого объекта.
- host ↔ String? чтение / запись
- Значение заголовка hostHeader, если он существует.
- ifModifiedSince ↔ DateTime? чтение / запись
- Дата и время, указанные в заголовке ifModifiedSinceHeader, если он существует.
- persistentConnection ↔ bool чтение / запись
- Является ли соединение постоянным (keep-alive).
- port ↔ int? чтение / запись
- Значение порта из заголовка hostHeader, если он существует.
- runtimeType → Type только для чтения, унаследовано
- Представление типа объекта во время выполнения.
Методы
- add(
String name, Object value, {bool preserveHeaderCase = false}) → void - Добавляет значение заголовка.
- clear(
) → void - Удаляет все заголовки.
- forEach(
void action(String name, List< String> values)) → void - Выполняет
actionдля каждого заголовка. - noFolding(
String name) → void - Отключает складывание для заголовка с именем
name, при отправке HTTP-заголовка. - noSuchMethod(
Invocation invocation) → dynamic унаследовано - Вызывается при обращении к несуществующему методу или свойству.
- remove(
String name, Object value) → void - Удаляет конкретное значение для имени заголовка.
- removeAll(
String name) → void - Удаляет все значения для указанного имени заголовка.
- set(
String name, Object value, {bool preserveHeaderCase = false}) → void - Устанавливает заголовок
nameнаvalue. - toString(
) → String унаследовано - Строковое представление этого объекта.
- value(
String name) → String? - Удобный метод для получения значения однозначного заголовка.
Операторы
- operator ==(
Object other) → bool унаследовано - Оператор равенства.
- operator [](
String name) → List< String>? - Значения для заголовка с именем
name.
Константы
- acceptCharsetHeader → const String
-
"accept-charset" - acceptEncodingHeader → const String
-
"accept-encoding" - acceptHeader → const String
-
"accept" - acceptLanguageHeader → const String
-
"accept-language" - acceptRangesHeader → const String
-
"accept-ranges" - accessControlAllowCredentialsHeader → const String @Since("2.14")
-
'access-control-allow-credentials' - accessControlAllowHeadersHeader → const String @Since("2.14")
-
'access-control-allow-headers' - accessControlAllowMethodsHeader → const String @Since("2.14")
-
'access-control-allow-methods' - accessControlAllowOriginHeader → const String @Since("2.14")
-
'access-control-allow-origin' - accessControlExposeHeadersHeader → const String @Since("2.14")
-
'access-control-expose-headers' - accessControlMaxAgeHeader → const String @Since("2.14")
-
'access-control-max-age' - accessControlRequestHeadersHeader → const String @Since("2.14")
-
'access-control-request-headers' - accessControlRequestMethodHeader → const String @Since("2.14")
-
'access-control-request-method' - ageHeader → const String
-
"age" - allowHeader → const String
-
"allow" - authorizationHeader → const String
-
"authorization" - cacheControlHeader → const String
-
"cache-control" - connectionHeader → const String
-
"connection" - contentEncodingHeader → const String
-
"content-encoding" - contentLanguageHeader → const String
-
"content-language" - contentLengthHeader → const String
-
"content-length" - contentLocationHeader → const String
-
"content-location" - contentMD5Header → const String
-
"content-md5" - contentRangeHeader → const String
-
"content-range" - contentTypeHeader → const String
-
"content-type" - cookieHeader → const String
-
"cookie" - dateHeader → const String
-
"date" - entityHeaders → const List<
String> -
[allowHeader, contentEncodingHeader, contentLanguageHeader, contentLengthHeader, contentLocationHeader, contentMD5Header, contentRangeHeader, contentTypeHeader, expiresHeader, lastModifiedHeader] - etagHeader → const String
-
"etag" - expectHeader → const String
-
"expect" - expiresHeader → const String
-
"expires" - fromHeader → const String
-
"from" - generalHeaders → const List<
String> -
[cacheControlHeader, connectionHeader, dateHeader, pragmaHeader, trailerHeader, transferEncodingHeader, upgradeHeader, viaHeader, warningHeader] - hostHeader → const String
-
"host" - ifMatchHeader → const String
-
"if-match" - ifModifiedSinceHeader → const String
-
"if-modified-since" - ifNoneMatchHeader → const String
-
"if-none-match" - ifRangeHeader → const String
-
"if-range" - ifUnmodifiedSinceHeader → const String
-
"if-unmodified-since" - lastModifiedHeader → const String
-
"last-modified" - locationHeader → const String
-
"location" - maxForwardsHeader → const String
-
"max-forwards" - pragmaHeader → const String
-
"pragma" - proxyAuthenticateHeader → const String
-
"proxy-authenticate" - proxyAuthorizationHeader → const String
-
"proxy-authorization" - rangeHeader → const String
-
"range" - refererHeader → const String
-
"referer" - requestHeaders → const List<
String> -
[acceptHeader, acceptCharsetHeader, acceptEncodingHeader, acceptLanguageHeader, authorizationHeader, expectHeader, fromHeader, hostHeader, ifMatchHeader, ifModifiedSinceHeader, ifNoneMatchHeader, ifRa… - responseHeaders → const List<
String> -
[acceptRangesHeader, ageHeader, etagHeader, locationHeader, proxyAuthenticateHeader, retryAfterHeader, serverHeader, varyHeader, wwwAuthenticateHeader]
- retryAfterHeader → const String
-
"retry-after" - serverHeader → const String
-
"server" - setCookieHeader → const String
-
"set-cookie" - teHeader → const String
-
"te" - trailerHeader → const String
-
"trailer" - transferEncodingHeader → const String
-
"transfer-encoding" - upgradeHeader → const String
-
"upgrade" - userAgentHeader → const String
-
"user-agent" - varyHeader → const String
-
"vary" - viaHeader → const String
-
"via" - warningHeader → const String
-
"warning" - wwwAuthenticateHeader → const String
-
"www-authenticate"
© 2012 the Dart project authors
Licensed under the BSD 3-Clause "New" or "Revised" License.
https://api.dart.dev/stable/2.18.5/dart-io/HttpHeaders-class.html