Class: NSHTTPCookieStorage
Overview
NSHTTPCookieStorage implements a singleton object (shared instance) that manages storage of cookies. Each cookie is represented by an instance of the NSHTTPCookie class. As a rule, cookies are shared among all applications and are kept in sync across process boundaries. Session cookies (where the cookie object’s isSessionOnly method returns YES) are local to a single process and are not shared.
Class Method Summary (collapse)
-
+ sharedHTTPCookieStorage
Returns the shared cookie storage instance.
Instance Method Summary (collapse)
-
- cookieAcceptPolicy
Returns the cookie storage’s cookie accept policy.
-
- cookies
Returns the cookie storage’s cookies.
-
- cookiesForURL:
Returns all the cookie storage’s cookies that are sent to a specified URL.
-
- deleteCookie:
Deletes the specified cookie from the cookie storage.
-
- setCookie:
Stores a specified cookie in the cookie storage if the cookie accept policy permits.
-
- setCookieAcceptPolicy:
Sets the cookie accept policy of the cookie storage.
-
- setCookies:forURL:mainDocumentURL:
Adds an array of cookies to the receiver if the receiver’s cookie acceptance policy permits.
-
- sortedCookiesUsingDescriptors:
Returns all of the cookie storage’s cookies, sorted according to a given set of sort descriptors.
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
Class Method Details
+ (NSHTTPCookieStorage) sharedHTTPCookieStorage
Returns the shared cookie storage instance.
Instance Method Details
- (NSHTTPCookieAcceptPolicy) cookieAcceptPolicy
Returns the cookie storage’s cookie accept policy.
- (Array) cookies
Returns the cookie storage’s cookies. If you want to sort the cookie storage’s cookies, you should use the sortedCookiesUsingDescriptors: method instead of sorting the result of this method.
- (Array) cookiesForURL(theURL)
Returns all the cookie storage’s cookies that are sent to a specified URL. An application can use NSHTTPCookie method requestHeaderFieldsWithCookies: to turn this array into a set of header fields to add to an NSMutableURLRequest object.
- (Object) deleteCookie(aCookie)
Deletes the specified cookie from the cookie storage.
- (Object) setCookie(aCookie)
Stores a specified cookie in the cookie storage if the cookie accept policy permits. The cookie replaces an existing cookie with the same name, domain, and path, if one exists in the cookie storage. This method accepts the cookie only if the receiver’s cookie accept policy is NSHTTPCookieAcceptPolicyAlways or NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain. The cookie is ignored if the receiver’s cookie accept policy is NSHTTPCookieAcceptPolicyNever.
- (Object) setCookieAcceptPolicy(aPolicy)
Sets the cookie accept policy of the cookie storage. The default cookie accept policy is NSHTTPCookieAcceptPolicyAlways. Changing the cookie policy affects all currently running applications using the cookie storage.
- (Object) setCookies(cookies, forURL:theURL, mainDocumentURL:mainDocumentURL)
Adds an array of cookies to the receiver if the receiver’s cookie acceptance policy permits. The cookies will replace existing cookies with the same name, domain, and path, if one exists in the cookie storage. The cookie will be ignored if the receiver’s cookie accept policy is NSHTTPCookieAcceptPolicyNever. To store cookies from a set of response headers, an application can use cookiesWithResponseHeaderFields:forURL: passing a header field dictionary and then use this method to store the resulting cookies in accordance with the receiver’s cookie acceptance policy.
- (Array) sortedCookiesUsingDescriptors(sortOrder)
Returns all of the cookie storage’s cookies, sorted according to a given set of sort descriptors.