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

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

Разработчик

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

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

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

NSURLRequest

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

NSURLRequest инкапсулирует два элемента исходных данных запроса загрузки: URL для загрузки, и политика использовать при консалтинге с кэшем содержания URL сделал доступным реализацией.

NSURLRequest разработан, чтобы быть расширенным для поддержки дополнительных протоколов путем добавления категорий, обеспечивающих методы доступа для собственных специфичных для протокола свойств. Те методы могут получить и установить фактические значения путем вызова NSURLProtocol методы propertyForKey:inRequest: и setProperty:forKey:inRequest:.

Непостоянный подкласс NSURLRequest NSMutableURLRequest.

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

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

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

Swift

import Foundation

Objective C

@import Foundation;

Доступность

Доступный в OS X v10.2 и позже.

Создание запросов
  • requestWithURL: + requestWithURL:

    Создает и возвращает URL-запрос на указанный URL с политикой кэша по умолчанию и значением тайм-аута.

    Объявление

    Objective C

    + (instancetype)requestWithURL:(NSURL *)theURL

    Параметры

    theURL

    URL для нового запроса.

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

    Недавно создаваемый URL-запрос.

    Обсуждение

    Политика кэша по умолчанию NSURLRequestUseProtocolCachePolicy и интервал тайм-аута по умолчанию составляет 60 секунд.

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

    Objective C

    @import Foundation;

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    + requestWithURL:cachePolicy:timeoutInterval:

  • init (URL:) - initWithURL:

    Возвращает URL-запрос на указанный URL с политикой кэша по умолчанию и значением тайм-аута.

    Объявление

    Swift

    convenience init(URL theURL: NSURL)

    Objective C

    - (instancetype)initWithURL:(NSURL *)theURL

    Параметры

    theURL

    URL для запроса.

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

    Инициализированный URL-запрос.

    Обсуждение

    Политика кэша по умолчанию NSURLRequestUseProtocolCachePolicy и интервал тайм-аута по умолчанию составляет 60 секунд.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – initWithURL:cachePolicy:timeoutInterval:

  • requestWithURL:cachePolicy:timeoutInterval: + requestWithURL:cachePolicy:timeoutInterval:

    Создает и возвращает инициализированный URL-запрос с указанными значениями.

    Объявление

    Objective C

    + (instancetype)requestWithURL:(NSURL *)theURL cachePolicy:(NSURLRequestCachePolicy)cachePolicy timeoutInterval:(NSTimeInterval)timeoutInterval

    Параметры

    theURL

    URL для нового запроса.

    cachePolicy

    Политика кэша для нового запроса.

    timeoutInterval

    Интервал тайм-аута для нового запроса, в секундах.

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

    Недавно создаваемый URL-запрос.

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

    Objective C

    @import Foundation;

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – initWithURL:cachePolicy:timeoutInterval:

  • init (URL:cachePolicy:timeoutInterval:) - initWithURL:cachePolicy:timeoutInterval:

    Возвращает инициализированный URL-запрос с указанными значениями.

    Объявление

    Swift

    init(URL theURL: NSURL, cachePolicy cachePolicy: NSURLRequestCachePolicy, timeoutInterval timeoutInterval: NSTimeInterval)

    Objective C

    - (instancetype)initWithURL:(NSURL *)theURL cachePolicy:(NSURLRequestCachePolicy)cachePolicy timeoutInterval:(NSTimeInterval)timeoutInterval

    Параметры

    theURL

    URL для запроса.

    cachePolicy

    Политика кэша для запроса.

    timeoutInterval

    Интервал тайм-аута для запроса, в секундах.

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

    Инициализированный URL-запрос.

    Обсуждение

    Это - определяемый инициализатор для NSURLRequest.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – initWithURL:

Получение свойств запроса
  • cachePolicy cachePolicy Свойство

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

    Объявление

    Swift

    var cachePolicy: NSURLRequestCachePolicy { get }

    Objective C

    @property(readonly) NSURLRequestCachePolicy cachePolicy

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    setCachePolicy:

  • HTTPShouldUsePipelining HTTPShouldUsePipelining Свойство

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

    Объявление

    Swift

    var HTTPShouldUsePipelining: Bool { get }

    Objective C

    @property(readonly) BOOL HTTPShouldUsePipelining

    Обсуждение

    YEStrue если запрос должен продолжать передавать данные; иначе, NOfalse.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.7 и позже.

    См. также

    setHTTPShouldUsePipelining:

  • mainDocumentURL mainDocumentURL Свойство

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

    Объявление

    Swift

    @NSCopying var mainDocumentURL: NSURL? { get }

    Objective C

    @property(readonly, copy) NSURL *mainDocumentURL

    Обсуждение

    Этот URL используется для cookie “тот же домен как основной документ” политика.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    setMainDocumentURL:

  • timeoutInterval timeoutInterval Свойство

    Интервал тайм-аута получателя, в секундах. (только для чтения)

    Объявление

    Swift

    var timeoutInterval: NSTimeInterval { get }

    Objective C

    @property(readonly) NSTimeInterval timeoutInterval

    Обсуждение

    Если во время попытки подключения запрос остается неактивным для дольше, чем интервал тайм-аута, запрос, как полагают, испытал таймаут.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    setTimeoutInterval:

  • networkServiceType networkServiceType Свойство

    Тип сетевой службы запроса. (только для чтения)

    Объявление

    Swift

    var networkServiceType: NSURLRequestNetworkServiceType { get }

    Objective C

    @property(readonly) NSURLRequestNetworkServiceType networkServiceType

    Обсуждение

    Тип сетевой службы обеспечивает подсказку для операционной системы о том, для чего используется базовый трафик. Эта подсказка улучшает возможность системы приоритезировать трафик, определить, как быстро это должно разбудить сотовую связь или радио Wi-Fi и т.д. Путем предоставления точной информации Вы улучшаете возможность системы оптимально сбалансировать время работы от батареи, производительность и другие соображения.

    Например, необходимо указать NSURLNetworkServiceTypeBackground введите, если Ваше приложение выполняет загрузку, которую не требовал пользователь — например, выбирая содержание с упреждением так, чтобы это было доступно, когда пользователь примет решение просмотреть его.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.7 и позже.

    См. также

    setNetworkServiceType:

  • URL URL Свойство

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

    Объявление

    Swift

    @NSCopying var URL: NSURL { get }

    Objective C

    @property(readonly, copy) NSURL *URL

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    setURL:

Получение свойств запроса HTTP
  • allHTTPHeaderFields allHTTPHeaderFields Свойство

    Все поля HTTP-заголовка получателя. (только для чтения)

    Объявление

    Swift

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

    Objective C

    @property(readonly, copy) NSDictionary *allHTTPHeaderFields

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – valueForHTTPHeaderField:
    setAllHTTPHeaderFields:

  • HTTPBody HTTPBody Свойство

    Данные Тела HTTP получателя. (только для чтения)

    Объявление

    Swift

    @NSCopying var HTTPBody: NSData? { get }

    Objective C

    @property(readonly, copy) NSData *HTTPBody

    Обсуждение

    Эти данные отправляются как тело сообщения запроса, как в HTTP POST запрос.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – HTTPBodyStream
    setHTTPBody:
    setHTTPBodyStream:

  • HTTPBodyStream HTTPBodyStream Свойство

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

    Объявление

    Swift

    var HTTPBodyStream: NSInputStream? { get }

    Objective C

    @property(readonly, retain) NSInputStream *HTTPBodyStream

    Обсуждение

    nil если не был установлен поток организации. Возвращенный поток для исследования только — не безопасно управлять потоком всегда.

    Получатель будет иметь или Тело HTTP или поток Тела HTTP, только один может быть установлен для запроса. Поток Тела HTTP сохраняется при копировании NSURLRequest когда запрос архивируется с помощью, объект, но потерян NSCoding протокол.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – HTTPBody
    setHTTPBody:
    setHTTPBodyStream:

  • HTTPMethod HTTPMethod Свойство

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

    Объявление

    Swift

    var HTTPMethod: String? { get }

    Objective C

    @property(readonly, copy) NSString *HTTPMethod

    Обсуждение

    Методом HTTP по умолчанию является «GET».

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    setHTTPMethod:

  • HTTPShouldHandleCookies HTTPShouldHandleCookies Свойство

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

    Объявление

    Swift

    var HTTPShouldHandleCookies: Bool { get }

    Objective C

    @property(readonly) BOOL HTTPShouldHandleCookies

    Обсуждение

    YEStrue если обработка cookie по умолчанию будет использоваться для этого запроса, NOfalse иначе. Значение по умолчанию YEStrue.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    setHTTPShouldHandleCookies:

  • valueForHTTPHeaderField (_:) - valueForHTTPHeaderField:

    Возвращает значение указанного поля HTTP-заголовка.

    Объявление

    Swift

    func valueForHTTPHeaderField(_ field: String) -> String?

    Objective C

    - (NSString *)valueForHTTPHeaderField:(NSString *)field

    Параметры

    field

    Имя поля заголовка, значение которого должно быть возвращено. В соответствии с HTTP RFC, имена полей HTTP-заголовка нечувствительны к регистру.

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

    Значение связалось с полем заголовка field, или nil если нет никакого соответствующего поля заголовка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – allHTTPHeaderFields
    addValue:forHTTPHeaderField:
    setValue:forHTTPHeaderField:

Предоставление сотового доступа
  • allowsCellularAccess allowsCellularAccess Свойство

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

    Объявление

    Swift

    var allowsCellularAccess: Bool { get }

    Objective C

    @property(readonly) BOOL allowsCellularAccess

    Обсуждение

    YEStrue если может использоваться сотовая радиосвязь; NOfalse иначе.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.8 и позже.

    См. также

    setAllowsCellularAccess:

Поддержка безопасного кодирования
  • supportsSecureCoding - supportsSecureCoding

    Указывает это NSURLRequest реализации NSSecureCoding протокол.

    Объявление

    Objective C

    - (BOOL)supportsSecureCoding

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

    YEStrue указать это NSURLRequest реализации NSSecureCoding протокол.

Константы
  • NSURLRequestCachePolicy

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

    Объявление

    Swift

    enum NSURLRequestCachePolicy : UInt { case UseProtocolCachePolicy case ReloadIgnoringLocalCacheData case ReloadIgnoringLocalAndRemoteCacheData case ReturnCacheDataElseLoad case ReturnCacheDataDontLoad case ReloadRevalidatingCacheData }

    Objective C

    enum { NSURLRequestUseProtocolCachePolicy = 0, NSURLRequestReloadIgnoringLocalCacheData = 1, NSURLRequestReturnCacheDataElseLoad = 2, NSURLRequestReturnCacheDataDontLoad = 3, }; typedef NSUInteger NSURLRequestCachePolicy;

    Константы

    • UseProtocolCachePolicy

      NSURLRequestUseProtocolCachePolicy

      Указывает, что кэширующаяся логика, определенная в реализации протокола, если таковые имеются, используется для определенного запроса загрузки URL. Это - политика по умолчанию для запросов загрузки URL. Эта политика описана далее в обсуждении ниже.

      Доступный в OS X v10.2 и позже.

    • ReloadIgnoringLocalCacheData

      NSURLRequestReloadIgnoringLocalCacheData

      Указывает, что данные для загрузки URL должны быть загружены из инициирующего источника. Никакие существующие данные кэша не должны использоваться для удовлетворения запроса загрузки URL.

      Доступный в OS X v10.5 и позже.

    • ReturnCacheDataElseLoad

      NSURLRequestReturnCacheDataElseLoad

      Указывает, что существующие кэшированные данные должны использоваться для удовлетворения запроса, независимо от его возраста или даты истечения срока. Если нет никаких существующих данных в кэше, соответствующем запрос, данные загружаются из инициирующего источника.

      Доступный в OS X v10.2 и позже.

    • ReturnCacheDataDontLoad

      NSURLRequestReturnCacheDataDontLoad

      Указывает, что существующие данные кэша должны использоваться для удовлетворения запроса, независимо от его возраста или даты истечения срока. Если нет никаких существующих данных в кэше, соответствующем запросу загрузки URL, никакая попытка не предпринята для загрузки данных из инициирующего источника, и загрузка, как полагают, перестала работать. Эта константа указывает поведение, которое подобно «оффлайновому» режиму.

      Доступный в OS X v10.2 и позже.

    Обсуждение

    Для протокола HTTP, поведения NSURLRequestUseProtocolCachePolicy политика показана в дереве решений NSURLRequestUseProtocolCachePolicy для HTTP и HTTPS.

    Дерево решений рисунка 1NSURLRequestUseProtocolCachePolicy для HTTP и HTTPS image: ../Art/http_caching.pdf

    Кратко помещенный:

    1. Если кэшируемый ответ не существует для запроса, загрузочная система URL выбирает данные из инициирующего источника.

    2. Иначе, если кэшируемый ответ не указывает, что должен быть подтвержден каждый раз, и если кэшируемый ответ не является устаревшим (мимо его даты истечения срока), загрузочная система URL возвращает кэшируемый ответ.

    3. Если кэшируемый ответ является устаревшим или требует придания вновь юридической силы, загрузочная система URL выполняет запрос HEAD к инициирующему источнику, чтобы видеть, изменился ли ресурс. Если так, загрузочная система URL выбирает данные из инициирующего источника. Иначе, это возвращает кэшируемый ответ.

    RFC 2616, Раздел 13 (http://www .w3.org/Protocols/rfc2616/rfc2616-sec13.html#sec13) указывает их семантика подробно.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 и позже.

  • NSURLRequestNetworkServiceType

    Эти константы используются для указания типа сетевой службы запроса.

    Объявление

    Swift

    enum NSURLRequestNetworkServiceType : UInt { case NetworkServiceTypeDefault case NetworkServiceTypeVoIP case NetworkServiceTypeVideo case NetworkServiceTypeBackground case NetworkServiceTypeVoice }

    Objective C

    enum { NSURLNetworkServiceTypeDefault = 0, NSURLNetworkServiceTypeVoIP = 1, NSURLNetworkServiceTypeVideo = 2, NSURLNetworkServiceTypeBackground = 3, NSURLNetworkServiceTypeVoice = 4 }; typedef NSUInteger NSURLRequestNetworkServiceType;

    Константы

    • NetworkServiceTypeDefault

      NSURLNetworkServiceTypeDefault

      Указывает стандартный сетевой трафик. Большинство соединений должно быть сделано с помощью этого типа службы.

      Доступный в OS X v10.7 и позже.

    • NetworkServiceTypeVoIP

      NSURLNetworkServiceTypeVoIP

      Указывает, что запрос для трафика VoIP.

      С типом службы VoIP ядро продолжает прислушиваться к входящему трафику, в то время как Ваше приложение в фоновом режиме, затем будит Ваше приложение каждый раз, когда поступают новые данные. Это должно использоваться только для соединений, использующихся для передачи со службой VoIP.

      Доступный в OS X v10.7 и позже.

    • NetworkServiceTypeVideo

      NSURLNetworkServiceTypeVideo

      Указывает, что запрос для видеотрафика.

      Доступный в OS X v10.7 и позже.

    • NetworkServiceTypeBackground

      NSURLNetworkServiceTypeBackground

      Указывает, что запрос для фонового трафика.

      Необходимо указать этот тип, если приложение выполняет загрузку, которую не требовал пользователь — например, выбирая содержание с упреждением так, чтобы это было доступно, когда пользователь примет решение просмотреть его.

      Доступный в OS X v10.7 и позже.

    • NetworkServiceTypeVoice

      NSURLNetworkServiceTypeVoice

      Указывает, что запрос для голосового трафика.

      Доступный в OS X v10.7 и позже.

    Обсуждение

    Тип сетевой службы обеспечивает подсказку для операционной системы о том, для чего используется базовый трафик. Эта подсказка улучшает возможность системы приоритезировать трафик, определить, как быстро это должно разбудить сотовую связь или радио Wi-Fi и т.д. Путем предоставления точной информации Вы улучшаете возможность системы оптимально сбалансировать время работы от батареи, производительность и другие соображения.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.7 и позже.