Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека Разработчика iOS

Разработчик

Ссылка платформы основы ссылка класса NSHTTPCookie

Опции
Развертывание Target:

На этой странице
Язык:

NSHTTPCookie

Наследование

Соответствует

Оператор импорта

Swift

import Foundation

Objective C

@import Foundation;

Доступность

Доступный в iOS 2.0 и позже.

NSHTTPCookie объект представляет cookie HTTP. Это - неизменный объект, инициализированный из словаря, содержащего атрибуты cookie.

NSHTTPCookie класс поддерживает две различных версии cookie:

  • Версия 0: Эта версия относится к «традиционным» или cookie «старого стиля», исходный формат cookie, определенный Netscape. Большинство cookie, с которыми встречаются, находится в этом формате.

  • Версия 1: Эта версия относится к cookie, как определено в RFC 2965, Механизме управления состоянием HTTP.

Создайте экземпляры cookie
  • cookiesWithResponseHeaderFields (_: forURL:) + cookiesWithResponseHeaderFields:forURL:

    Возвращает массив объектов NSHTTPCookie, соответствующих предоставленным полям заголовка ответа для предоставленного URL.

    Объявление

    Swift

    class func cookiesWithResponseHeaderFields(_ headerFields: [NSObject : AnyObject], forURL theURL: NSURL) -> [AnyObject]

    Objective C

    + (NSArray *)cookiesWithResponseHeaderFields:(NSDictionary *)headerFields forURL:(NSURL *)theURL

    Параметры

    headerFields

    Поля заголовка раньше создавали NSHTTPCookie объекты.

    theURL

    URL связался с создаваемыми cookie.

    Возвращаемое значение

    Массив создаваемых cookie.

    Обсуждение

    Этот метод игнорирует несоответствующие поля заголовка в headerFields, разрешение словарей содержать дополнительные данные.

    Если headerFields не указывает домен для данного cookie, cookie создается со значением домена по умолчанию theURL.

    Если headerFields не указывает путь для данного cookie, cookie создается со значением пути по умолчанию "/".

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • + cookieWithProperties:

    Создает и инициализирует объект NSHTTPCookie использование предоставленных свойств.

    Объявление

    Objective C

    + (NSHTTPCookie *)cookieWithProperties:(NSDictionary *)properties

    Параметры

    properties

    Свойства для нового объекта cookie, выраженного как пары значения ключа.

    Возвращаемое значение

    Недавно создаваемый объект cookie. Возвраты nil если предоставленные свойства недопустимы.

    Обсуждение

    Для успешного создания cookie необходимо обеспечить значения для (по крайней мере), NSHTTPCookiePath, NSHTTPCookieName, и NSHTTPCookieValue ключи и любой NSHTTPCookieOriginURL ключ или NSHTTPCookieDomain ключ.

    Посмотрите Константы для получения дополнительной информации о доступных константах атрибута cookie и ограничениях, наложенных на значения в словаре.

    Оператор импорта

    Objective C

    @import Foundation;

    Доступность

    Доступный в iOS 2.0 и позже.

    См. также

    – initWithProperties:

  • init (свойства:) - initWithProperties:

    Возвращает инициализированный NSHTTPCookie объект с помощью предоставленных свойств.

    Объявление

    Swift

    init?(properties properties: [NSObject : AnyObject])

    Objective C

    - (instancetype)initWithProperties:(NSDictionary *)properties

    Параметры

    properties

    Свойства для нового объекта cookie, выраженного как пары значения ключа.

    Возвращаемое значение

    Инициализированный объект cookie. Возвраты nil если предоставленные свойства недопустимы.

    Обсуждение

    Для успешного создания cookie необходимо обеспечить значения для (по крайней мере), NSHTTPCookiePath, NSHTTPCookieName, и NSHTTPCookieValue ключи и любой NSHTTPCookieOriginURL ключ или NSHTTPCookieDomain ключ.

    Посмотрите Константы для получения дополнительной информации о доступных константах атрибута cookie и ограничениях, наложенных на значения в словаре.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

    См. также

    + cookieWithProperties:

Преобразуйте cookie для запроса заголовков
  • requestHeaderFieldsWithCookies (_:) + requestHeaderFieldsWithCookies:

    Возвращает словарь полей заголовка, соответствующих предоставленному массиву cookie.

    Объявление

    Swift

    class func requestHeaderFieldsWithCookies(_ cookies: [AnyObject]) -> [NSObject : AnyObject]

    Objective C

    + (NSDictionary *)requestHeaderFieldsWithCookies:(NSArray *)cookies

    Параметры

    cookies

    Cookie, из которых создаются поля заголовка.

    Возвращаемое значение

    Словарь полей заголовка создается из предоставленных cookie.

    Обсуждение

    Для отправки этих заголовков как части URL-запроса к удаленному серверу создайте NSMutableURLRequest объект, затем вызовите setAllHTTPHeaderFields: или setValue:forHTTPHeaderField: метод для установки предоставленных заголовков для запроса. Наконец, инициализируйте и запуститесь NSURLSessionTask, NSURLConnection, или NSURLDownload основанный на объектах на том объекте запроса.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

Получение свойств cookie
  • comment Свойство

    Строка комментария получателя. (только для чтения)

    Объявление

    Swift

    var comment: String? { get }

    Objective C

    @property(readonly, copy) NSString *comment

    Обсуждение

    Строка комментария получателя или nil если cookie не имеет никакого комментария. Эта строка подходит для представления для пользователя, объясняя содержание и цель этого cookie.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • commentURL Свойство

    Комментарий получателя URL. (только для чтения)

    Объявление

    Swift

    @NSCopying var commentURL: NSURL? { get }

    Objective C

    @property(readonly, copy) NSURL *commentURL

    Обсуждение

    Комментарий получателя URL или nil если cookie не имеет ни одного. Это значение указывает URL, подходящий для представления для пользователя как ссылка для получения дополнительной информации об этом cookie.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • domain Свойство

    Домен cookie получателя. (только для чтения)

    Объявление

    Swift

    var domain: String { get }

    Objective C

    @property(readonly, copy) NSString *domain

    Обсуждение

    Если домен не запускается с точки, то cookie только отправляется в точный узел, указанный доменом. Если домен действительно запускается с точки, то cookie отправляется в другие узлы в том домене также согласно определенным ограничениям. Посмотрите RFC 2965 для большего количества подробности.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • expiresDate Свойство

    Дата истечения срока получателя. (только для чтения)

    Объявление

    Swift

    @NSCopying var expiresDate: NSDate! { get }

    Objective C

    @property(readonly, copy) NSDate *expiresDate

    Обсуждение

    Дата истечения срока получателя, или nil если нет никакой определенной даты истечения срока такого как в случае cookie «только для сеанса». Когда cookie должен быть удален, дата истечения срока является датой.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • HTTPOnly Свойство

    Булево значение, указывающее, должен ли получатель только быть отправлен в серверы HTTP на RFC 2965. (только для чтения)

    Объявление

    Swift

    var HTTPOnly: Bool { get }

    Objective C

    @property(readonly, getter=isHTTPOnly) BOOL HTTPOnly

    Обсуждение

    Возвраты YEStrue если этот cookie должен только быть отправлен через HTTP-заголовки, NOfalse иначе.

    Cookie могут быть отмечены как HTTP только сервером (или javascript). Cookie отметили как таковой, должен только быть отправлен через HTTP-заголовки в Запросах HTTP для URL's, соответствующего и путь и домен соответствующих cookie.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • secure Свойство

    Булево значение, указывающее, должен ли этот cookie только быть отправлен по безопасным каналам. (только для чтения)

    Объявление

    Swift

    var secure: Bool { get }

    Objective C

    @property(readonly, getter=isSecure) BOOL secure

    Обсуждение

    YEStrue если этот cookie должен только быть отправлен по безопасным каналам, иначе NOfalse.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • sessionOnly Свойство

    Булево значение, указывающее, должен ли получатель быть отброшен в конце сеанса (независимо от даты истечения срока). (только для чтения)

    Объявление

    Swift

    var sessionOnly: Bool { get }

    Objective C

    @property(readonly, getter=isSessionOnly) BOOL sessionOnly

    Обсуждение

    YEStrue если получатель должен быть отброшен в конце сеанса (независимо от даты истечения срока), иначе NOfalse.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • name Свойство

    Имя получателя. (только для чтения)

    Объявление

    Swift

    var name: String { get }

    Objective C

    @property(readonly, copy) NSString *name

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • path Свойство

    Путь получателя. (только для чтения)

    Объявление

    Swift

    var path: String? { get }

    Objective C

    @property(readonly, copy) NSString *path

    Обсуждение

    Cookie будет отправлен с запросами на этот путь в домене cookie и все пути, имеющие этот префикс. Путь "/" означает, что cookie будет отправлен за всем URLs в домене.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • portList Свойство

    Список портов получателя. (только для чтения)

    Объявление

    Swift

    var portList: [AnyObject]? { get }

    Objective C

    @property(readonly, copy) NSArray *portList

    Обсуждение

    Список портов для cookie, возвращенного как массив NSNumber объекты, содержащие целые числа. Если cookie не имеет никакого списка портов этот метод возвраты nil и cookie будет отправлен в любой порт. Иначе, cookie только отправляется в порты, указанные в списке портов.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • properties Свойство

    Свойства cookie получателя. (только для чтения)

    Объявление

    Swift

    var properties: [NSObject : AnyObject]? { get }

    Objective C

    @property(readonly, copy) NSDictionary *properties

    Обсуждение

    Этот словарь может использоваться с initWithProperties: или cookieWithProperties: создать эквивалент NSHTTPCookie объект.

    Посмотрите initWithProperties: для получения дополнительной информации об ограничениях, наложенных на properties словарь.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • value Свойство

    Значение получателя. (только для чтения)

    Объявление

    Swift

    var value: String? { get }

    Objective C

    @property(readonly, copy) NSString *value

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

  • version Свойство

    Версия получателя. (только для чтения)

    Объявление

    Swift

    var version: Int { get }

    Objective C

    @property(readonly) NSUInteger version

    Обсуждение

    Версия получателя. Версия 0 отображается на cookie Netscape «старого стиля». Версия 1 отображает на RFC 2 965 cookie.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 2.0 и позже.

Константы
  • Ключи атрибута Cookie HTTP

    Эти константы определяют поддерживаемые ключи в словаре атрибутов cookie.

    Объявление

    Swift

    let NSHTTPCookieComment: String let NSHTTPCookieCommentURL: String let NSHTTPCookieDiscard: String let NSHTTPCookieDomain: String let NSHTTPCookieExpires: String let NSHTTPCookieMaximumAge: String let NSHTTPCookieName: String let NSHTTPCookieOriginURL: String let NSHTTPCookiePath: String let NSHTTPCookiePort: String let NSHTTPCookieSecure: String let NSHTTPCookieValue: String let NSHTTPCookieVersion: String

    Objective C

    NSString *NSHTTPCookieComment; NSString *NSHTTPCookieCommentURL; NSString *NSHTTPCookieDiscard; NSString *NSHTTPCookieDomain; NSString *NSHTTPCookieExpires; NSString *NSHTTPCookieMaximumAge; NSString *NSHTTPCookieName; NSString *NSHTTPCookieOriginURL; NSString *NSHTTPCookiePath; NSString *NSHTTPCookiePort; NSString *NSHTTPCookieSecure; NSString *NSHTTPCookieValue; NSString *NSHTTPCookieVersion;

    Константы

    • NSHTTPCookieComment

      NSString объект, содержащий комментарий для cookie.

      Только допустимый для cookie Версии 1 и позже. Этот атрибут cookie является дополнительным.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieCommentURL

      NSURL объект или NSString объект, содержащий комментарий URL для cookie.

      Только допустимый для cookie Версии 1 или позже. Этот атрибут cookie является дополнительным.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieDiscard

      NSString объект, утверждающий, должен ли cookie быть отброшен в конце сеанса.

      Строковое значение должно быть также "TRUE" или "FALSE". Этот атрибут cookie является дополнительным. Значение по умолчанию "FALSE", если этот cookie не является версией 1 или больше и значение для NSHTTPCookieMaximumAge не указан, когда это, как предполагается, "TRUE".

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieDomain

      NSString объект, содержащий домен для cookie.

      Если этот атрибут cookie отсутствует, домен выведен из значения для NSHTTPCookieOriginURL. Если Вы не указываете значение для NSHTTPCookieOriginURL, необходимо указать значение для NSHTTPCookieDomain.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieExpires

      NSDate объект или NSString объект, указывающий дату истечения срока cookie.

      Этот атрибут cookie только используется для cookie Версии 0. Этот атрибут cookie является дополнительным.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieMaximumAge

      NSString объект, содержащий целочисленное значение, утверждающее, сколько времени в секундах cookie должен быть сохранен, самое большее.

      Только допустимый для cookie Версии 1 и позже. Значение по умолчанию "0". Этот атрибут cookie является дополнительным.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieName

      NSString объект, содержащий имя cookie. Этот атрибут cookie требуется.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieOriginURL

      NSURL или NSString объект, содержащий URL, устанавливающий этот cookie.

      Если Вы не обеспечиваете значение для NSHTTPCookieOriginURL, необходимо обеспечить значение для NSHTTPCookieDomain.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookiePath

      NSString объект, содержащий путь для cookie.

      Этот атрибут cookie требуется.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookiePort

      NSString объект, содержащий разделенные от запятой целочисленные значения, указывающие порты для cookie.

      Только допустимый для cookie Версии 1 или позже. Значение по умолчанию является пустой строкой (""). Этот атрибут cookie является дополнительным.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieSecure

      NSString объект, указывающий, что cookie должен быть передан только по безопасным каналам.

      Обеспечение любого значения для этого ключа указывает, что cookie должен остаться безопасным.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieValue

      NSString объект, содержащий значение cookie.

      Этот атрибут cookie требуется.

      Доступный в iOS 2.0 и позже.

    • NSHTTPCookieVersion

      NSString объект, указывающий версию cookie.

      Должен быть также "0" или "1". Значение по умолчанию "0". Этот атрибут cookie является дополнительным.

      Доступный в iOS 2.0 и позже.