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

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

Разработчик

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

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

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

NSMutableURLRequest

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

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

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

Swift

import Foundation

Objective C

@import Foundation;

Доступность

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

NSMutableURLRequest подкласс NSURLRequest если помочь разработчикам, которые могут найти, что это более удобный для видоизменения единственного запроса возражает для серии запросов загрузки URL вместо того, чтобы создать неизменное NSURLRequest объект для каждой загрузки.

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

NSURLSession, NSURLConnection, и NSURLDownload классы делают глубокую копию из каждого NSMutableURLRequest объект передал их инициализаторам и методам создания задачи.

Установка свойств запроса
  • cachePolicy Свойство

    Политика кэша получателя.

    Объявление

    Swift

    var cachePolicy: NSURLRequestCachePolicy

    Objective C

    @property NSURLRequestCachePolicy cachePolicy

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • mainDocumentURL Свойство

    Основной документ URL для получателя.

    Объявление

    Swift

    @NSCopying var mainDocumentURL: NSURL?

    Objective C

    @property(copy) NSURL *mainDocumentURL

    Обсуждение

    Вызывающая сторона должна установить основной документ URL в надлежащий основной документ, если известный. Например, при загрузке веб-страницы URL документа HTML для кадра верхнего уровня был бы надлежащим. Этот URL будет использоваться для “только от того же домена, как основной документ” cookie принимает политику.

    nil не указывает основного документа.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • networkServiceType Свойство

    Тип сетевой службы соединения.

    Объявление

    Swift

    var networkServiceType: NSURLRequestNetworkServiceType

    Objective C

    @property NSURLRequestNetworkServiceType networkServiceType

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • timeoutInterval Свойство

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

    Объявление

    Swift

    var timeoutInterval: NSTimeInterval

    Objective C

    @property NSTimeInterval timeoutInterval

    Обсуждение

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

    Как правило Вы не должны использовать короткие интервалы тайм-аута. Вместо этого необходимо обеспечить простой способ к пользователю отменить продолжительную работу. Для получения дополнительной информации читайте Разработку для Реальных Сетей.

    Специальные замечания

    В версиях iOS до iOS 6 минимум (и значение по умолчанию) интервал тайм-аута для любого запроса, содержащего организацию запроса, составлял 240 секунд.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • URL Свойство

    URL получателя

    Объявление

    Swift

    @NSCopying var URL: NSURL?

    Objective C

    @property(copy) NSURL *URL

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • allowsCellularAccess Свойство

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

    Объявление

    Swift

    var allowsCellularAccess: Bool

    Objective C

    @property BOOL allowsCellularAccess

    Обсуждение

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Установка HTTP определенные свойства
  • addValue (_: forHTTPHeaderField:) - addValue:forHTTPHeaderField:

    Добавляет HTTP-заголовок к словарю HTTP-заголовка получателя.

    Объявление

    Swift

    func addValue(_ value: String?, forHTTPHeaderField field: String)

    Objective C

    - (void)addValue:(NSString *)value forHTTPHeaderField:(NSString *)field

    Параметры

    value

    Значение для поля заголовка.

    field

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

    Обсуждение

    Этот метод предоставляет возможность к добавленным стоимостям к полям заголовка инкрементно. Если значение было ранее установлено для указанного field, предоставленный value добавляется к существующему значению с помощью надлежащего разделителя полей. В случае HTTP разделитель является запятой.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – setValue:forHTTPHeaderField:
    valueForHTTPHeaderField:

  • allHTTPHeaderFields Свойство

    Поля заголовка получателя.

    Объявление

    Swift

    var allHTTPHeaderFields: [NSObject : AnyObject]?

    Objective C

    @property(copy) NSDictionary *allHTTPHeaderFields

    Обсуждение

    Поля HTTP-заголовка должны быть строковыми значениями; поэтому, каждый объект и ключ headerFields словарь должен быть подклассом NSString. Если или ключ или значение для пары ключ/значение не являются подклассом NSString, пара ключ/значение пропускается.

    NSURLConnection и NSURLSession классы разработаны для обработки различных аспектов протокола HTTP для Вас. В результате Вы не должны изменять следующие заголовки:

    • Authorization

    • Connection

    • Host

    • WWW-Authenticate

    Кроме того, если длина Ваших данных организации загрузки может быть определена автоматически (например, при обеспечении содержания организации NSData объект), тогда значение Content-Length установлен для Вас.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – addValue:forHTTPHeaderField:
    – setValue:forHTTPHeaderField:

  • HTTPBody Свойство

    Организация запроса получателя.

    Объявление

    Swift

    @NSCopying var HTTPBody: NSData?

    Objective C

    @property(copy) NSData *HTTPBody

    Обсуждение

    Организация запроса отправляется как тело сообщения запроса, как в HTTP POST запрос. Установка данных Тела HTTP очищает любой входной поток в HTTPBodyStream. Эти значения являются взаимоисключающими.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    HTTPBodyStream

  • HTTPBodyStream Свойство

    Организация запроса как входной поток.

    Объявление

    Swift

    var HTTPBodyStream: NSInputStream?

    Objective C

    @property(retain) NSInputStream *HTTPBodyStream

    Обсуждение

    Организация запроса получателя будет этим входным потоком. Все содержание потока будет отправлено как организация, как в HTTP POST запрос. Входной поток должен быть нераскрытым, и получатель вступит во владение как делегат потока.

    Установка потока организации очищает любые данные в HTTPBody. Эти значения являются взаимоисключающими.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    HTTPBody

  • HTTPMethod Свойство

    Метод Запроса HTTP получателя.

    Объявление

    Swift

    var HTTPMethod: String

    Objective C

    @property(copy) NSString *HTTPMethod

    Обсуждение

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • HTTPShouldHandleCookies Свойство

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

    Объявление

    Swift

    var HTTPShouldHandleCookies: Bool

    Objective C

    @property BOOL HTTPShouldHandleCookies

    Обсуждение

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

    Если Ваше приложение устанавливает Cookie заголовок на NSMutableURLRequest объект, тогда этот метод не имеет никакого эффекта, и cookie-данные, которые Вы устанавливаете в заголовке, переопределяют все cookie от хранилища cookie.

    Специальные замечания

    В OS X v10.2 с Safari 1.0 набор значений этим методом не уважает платформа.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    HTTPShouldHandleCookies

  • HTTPShouldUsePipelining Свойство

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

    Объявление

    Swift

    var HTTPShouldUsePipelining: Bool

    Objective C

    @property BOOL HTTPShouldUsePipelining

    Обсуждение

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

    Установка этого свойства к YEStrue значение не гарантирует поведения конвейерной обработки HTTP. Это не может иметь никакого эффекта, если Прокси HTTP будет сконфигурирован, или если Запрос HTTP будет использовать небезопасный метод запроса — например, то запросы POST не конвейерно обработают. Конвейерная обработка поведения может не начаться до второго запроса на данном соединении TCP. Могут быть другие ситуации, где конвейерная обработка не происходит даже при том, что это свойство установлено в YEStrue. HTTP 1.1 позволяет клиенту отправлять многократные запросы к серверу, не ожидая ответа. Хотя HTTP 1.1 требует поддержки конвейерной обработки, некоторые серверы сообщают о себе как являющийся HTTP 1.1, но не поддерживают конвейерную обработку (разъединение, отправка ресурсов в неправильном порядке, исключение части ресурса, и т.д.).

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • setValue (_: forHTTPHeaderField:) - setValue:forHTTPHeaderField:

    Устанавливает указанное поле HTTP-заголовка.

    Объявление

    Swift

    func setValue(_ value: String?, forHTTPHeaderField field: String)

    Objective C

    - (void)setValue:(NSString *)value forHTTPHeaderField:(NSString *)field

    Параметры

    value

    Новое значение для поля заголовка. Любое существующее значение для поля заменяется новым значением.

    field

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

    Обсуждение

    NSURLConnection класс и NSURLSession классы разработаны для обработки различных аспектов протокола HTTP для Вас. В результате Вы не должны изменять следующие заголовки:

    • Authorization

    • Connection

    • Host

    • WWW-Authenticate

    Кроме того, если длина Ваших данных организации загрузки может быть определена автоматически (например, при обеспечении содержания организации NSData объект), тогда значение Content-Length установлен для Вас.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – addValue:forHTTPHeaderField:
    valueForHTTPHeaderField: