Class: NSURLResponse

Inherits:
NSObject show all

Overview

NSURLResponse declares the programmatic interface for an object that accesses the response returned by an NSURLRequest instance.

Direct Known Subclasses

NSHTTPURLResponse

Instance Method Summary (collapse)

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version

Constructor Details

This class inherits a constructor from NSObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class NSObject

Instance Method Details

- (Integer) expectedContentLength

Returns the receiver’s expected content length Some protocol implementations report the content length as part of the response, but not all protocols guarantee to deliver that amount of data. Clients should be prepared to deal with more or less data.

Returns:

  • (Integer) —

    The receiver’s expected content length, or NSURLResponseUnknownLength if the length can’t be determined.

- (Object) initWithURL(URL, MIMEType:MIMEType, expectedContentLength:length, textEncodingName:name)

Returns an initialized NSURLResponse object with the URL, MIME type, length, and text encoding set to given values. This is the designated initializer for NSURLResponse.

Parameters:

  • URL (NSURL) —

    The URL for the new object.

  • MIMEType (String) —

    The MIME type.

  • length (Integer) —

    The expected content length.This value should be –1 if the expected length is undetermined

  • name (String) —

    The text encoding name. This value may be nil.

Returns:

  • (Object) —

    An initialized NSURLResponse object with the URL set to URL, the MIME type set to MIMEType, length set to length, and text encoding name set to name.

- (Object) initWithURL(url, statusCode:statusCode, HTTPVersion:HTTPVersion, headerFields:headerFields)

Returns an initialized response with the specified values.

Parameters:

  • url (NSURL) —

    The URL for the new object.

  • statusCode (Integer) —

    The HTTP status code to return.

  • HTTPVersion (String) —

    The version of the HTTP response as represented by the server. This is typically represented as "HTTP/1.1"

  • headerFields (Hash) —

    A dictionary representing the header keys and values of the server response.

Returns:

  • (Object) —

    An initialized NSURLResponse object or NULL if an error occurred during initialization.

- (String) MIMEType

Returns the receiver’s MIME type. The MIME type is often provided by the response’s originating source. However, that value may be changed or corrected by a protocol implementation if it can be determined that the response’s source reported the information incorrectly. If the response’s originating source does not provide a MIME type, an attempt to guess the MIME type may be made.

Returns:

  • (String) —

    The receiver’s MIME type.

- (String) suggestedFilename

Returns a suggested filename for the response data. The method tries to create a filename using the following, in order:A filename specified using the content disposition header.The last path component of the URL.The host of the URL.If the host of URL can’t be converted to a valid filename, the filename “unknown” is used.In most cases, this method appends the proper file extension based on the MIME type. This method will always return a valid filename regardless of whether or not the resource is saved to disk.

Returns:

  • (String) —

    A suggested filename for the response data.

- (String) textEncodingName

Returns the name of the receiver’s text encoding provided by the response’s originating source. Clients can convert this string to an NSStringEncoding or a CFStringEncoding using the methods and functions available in the appropriate framework.

Returns:

  • (String) —

    The name of the receiver’s text encoding provided by the response’s originating source, or nil if no text encoding was provided by the protocol

- (NSURL) URL

Returns the receiver’s URL.

Returns:

  • (NSURL) —

    The receiver’s URL.